DDLBooleanSolid Class Reference

This class takes care of processing all BooleanSolid type elements. More...

#include <DDLBooleanSolid.h>

Inheritance diagram for DDLBooleanSolid:

Public Member Functions
	DDLBooleanSolid (DDLElementRegistry *myreg)
void	preProcessElement (const std::string &name, const std::string &nmspace, DDCompactView &cpv) override
	Called by loadAttributes AFTER attributes are loaded. More...
void	processElement (const std::string &name, const std::string &nmspace, DDCompactView &cpv) override
	Processing the element. More...
Public Member Functions inherited from DDLSolid
	DDLSolid (DDLElementRegistry *myreg)
	Constructor. More...
void	setReference (const std::string &nmspace, DDCompactView &cpv)
Public Member Functions inherited from DDXMLElement
void	appendText (const std::string &inText)
	append to the current (i.e. most recently added) More...
virtual std::vector< DDXMLAttribute >::const_iterator	begin (void)
virtual void	clear (void)
	clear this element's contents. More...
	DDXMLElement (DDLElementRegistry *myreg)
	Constructor. More...
	DDXMLElement (DDLElementRegistry *myreg, const bool &clearme)
	Constructor for autoClear element. More...
virtual std::vector< DDXMLAttribute >::const_iterator	end (void)
virtual const std::string &	get (const std::string &name, size_t aIndex=0) const
	Returns a specific value from the aIndex set of attributes. More...
virtual const std::string &	getAttribute (const std::string &name) const
	Access to attributes by name. More...
virtual const DDXMLAttribute &	getAttributeSet (size_t aIndex=0) const
	Get a "row" of attributes, i.e. one attribute set. More...
const virtual DDName	getDDName (const std::string &defaultNS, const std::string &attname=std::string("name"), size_t aIndex=0)
const std::string	getText (size_t tindex=0) const
	retrieve the text blob. More...
virtual std::vector< std::string >	getVectorAttribute (const std::string &name)
	Returns a set of values as a std::vector of strings, given the attribute name. More...
virtual bool	gotText (void) const
	gotText()? kind of like gotMilk? Yes = text has already been encountered. More...
virtual bool	isEmpty (void) const
	Have any elements of this type been encountered but not processed? More...
void	loadAttributes (const std::string &elemName, const std::vector< std::string > &names, const std::vector< std::string > &values, const std::string &nmspace, DDCompactView &cpv)
	Load the element attributes. More...
void	loadText (const std::string &inText)
	Used to load both text and XML comments into this object. More...
std::vector< DDXMLAttribute >::const_iterator &	operator++ (int inc)
	Allow the elements of this type to be iterated over using ++ operator. More...
const std::string &	parent (void) const
	access to parent element name More...
void	setParent (const std::string &pename)
	Set parent element name to central list of names. More...
void	setSelf (const std::string &sename)
	Set self element name to central list of names. More...
virtual size_t	size (void) const
	Number of elements accumulated. More...
virtual void	stream (std::ostream &os) const
	Allow for the elements to have their own streaming method, but also provide a default. More...
void	throwError (const std::string &keyMessage) const
	format std::string for throw an error. More...
virtual	~DDXMLElement (void)=default
	Destructor. More...

Private Member Functions
std::string	dumpBooleanSolid (const std::string &name, const std::string &nmspace)

Additional Inherited Members
Protected Attributes inherited from DDXMLElement
DDLElementRegistry *	myRegistry_

Detailed Description

This class takes care of processing all BooleanSolid type elements.

Author

Michael Case

DDLBooleanSolid.h - description

begin: Wed Dec 12, 2001 email: case@.nosp@m.ucdh.nosp@m.ep.uc.nosp@m.davi.nosp@m.s.edu

This is the Intersection, Subtraction and Union processor. A BooleanSolid handles all of these because as far as the DDL is concerned, they have the same basic form, including two solid references, and potentially one translation and one rotation.

Definition at line 27 of file DDLBooleanSolid.h.

Constructor & Destructor Documentation

DDLBooleanSolid()

DDLBooleanSolid::DDLBooleanSolid

(

DDLElementRegistry *

myreg

)

Definition at line 14 of file DDLBooleanSolid.cc.

: DDLSolid(myreg) {}

Member Function Documentation

dumpBooleanSolid()

std::string DDLBooleanSolid::dumpBooleanSolid ( const std::string &  name, const std::string &  nmspace  )

private

Definition at line 99 of file DDLBooleanSolid.cc.

                                                                                           {
  std::string s;
  DDXMLAttribute atts = getAttributeSet();
 
  s = std::string("\n<") + name + " name=\"" + atts.find("name")->second + "\"";
 
  if (atts.find("firstSolid") != atts.end())
    s += " firstSolid=\"" + atts.find("firstSolid")->second + "\"";
  if (atts.find("secondSolid") != atts.end())
    s += " secondSolid=\"" + atts.find("secondSolid")->second + "\"";
  s += ">\n";
 
  auto myrSolid = myRegistry_->getElement("rSolid");            // get rSolid children
  auto myTranslation = myRegistry_->getElement("Translation");  // get Translation child
  auto myrRotation = myRegistry_->getElement("rRotation");      // get rRotation child
  if (myrSolid->size() > 0) {
    for (size_t i = 0; i < myrSolid->size(); ++i) {
      atts = myrSolid->getAttributeSet(i);
      s += "<rSolid name=\"" + atts.find("name")->second + "\"/>\n";
    }
  }
 
  atts = myTranslation->getAttributeSet();
  s += "<Translation";
  if (atts.find("x") != atts.end())
    s += " x=\"" + atts.find("x")->second + "\"";
  if (atts.find("y") != atts.end())
    s += " y=\"" + atts.find("y")->second + "\"";
  if (atts.find("z") != atts.end())
    s += " z=\"" + atts.find("z")->second + "\"";
  s += "/>\n";
 
  atts = myrRotation->getAttributeSet();
  if (atts.find("name") != atts.end()) {
    s += "<rRotation name=\"" + atts.find("name")->second + "\"/>\n";
  }
  s += "</" + name + ">\n\n";
  return s;
}

References DDXMLElement::getAttributeSet(), DDLElementRegistry::getElement(), mps_fire::i, DDXMLElement::myRegistry_, Skims_PA_cff::name, alignCSCRings::s, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by processElement().

preProcessElement()

void DDLBooleanSolid::preProcessElement ( const std::string &  name, const std::string &  nmspace, DDCompactView &  cpv  )

overridevirtual

Called by loadAttributes AFTER attributes are loaded.

The preProcessElement method can assume that the attributes are loaded and perform any code that is necessary at the start of an element.

This would allow users to call their own code to setup anything necessary for the continued processing of the child elements.

Reimplemented from DDXMLElement.

Definition at line 17 of file DDLBooleanSolid.cc.

                                                                                                           {
  myRegistry_->getElement("rSolid")->clear();
}

References DDLElementRegistry::getElement(), and DDXMLElement::myRegistry_.

processElement()

void DDLBooleanSolid::processElement ( const std::string &  name, const std::string &  nmspace, DDCompactView &  cpv  )

overridevirtual

Processing the element.

The processElement method completes any necessary work to process the XML element.

For example, this can be used to call the DDCore to make the geometry in memory. There is a default for this so that if not declared in the inheriting class, no processing is done.

Reimplemented from DDXMLElement.

Definition at line 24 of file DDLBooleanSolid.cc.

                                                                                                        {
  // new DDLBoolean will handle:
  // <UnionSolid name="bs" firstSolid="blah" secondSolid="argh"> <Translation...> <rRotation .../> </UnionSolid
  // AND <UnionSolid> <rSolid...> <rSolid...> <Translation...> <rRotation...> </UnionSolid>
 
  auto myrSolid = myRegistry_->getElement("rSolid");            // get rSolid children
  auto myTranslation = myRegistry_->getElement("Translation");  // get Translation child
  auto myrRotation = myRegistry_->getElement("rRotation");      // get rRotation child
 
  ClhepEvaluator& ev = myRegistry_->evaluator();
  DDXMLAttribute atts = getAttributeSet();
 
  DDName ddn1, ddn2;
  double x = 0.0, y = 0.0, z = 0.0;
  DDRotation ddrot;
 
  // Basically check if there are rSolids or Translation or rRotation then we have
  // should NOT have any of the attributes shown above.
  if (myrSolid->size() == 0) {
    // do the solids using the attributes only.
    if (atts.find("firstSolid") != atts.end() && atts.find("secondSolid") != atts.end()) {
      ddn1 = getDDName(nmspace, "firstSolid");
      ddn2 = getDDName(nmspace, "secondSolid");
    } else {
      std::string s("DDLBooleanSolid did not find any solids with which to form a boolean solid.");
      s += dumpBooleanSolid(name, nmspace);
      throwError(s);
    }
  } else if (myrSolid->size() == 2) {
    ddn1 = myrSolid->getDDName(nmspace, "name", 0);
    ddn2 = myrSolid->getDDName(nmspace, "name", 1);
  } else {
    std::string s("DDLBooleanSolid did not find any solids with which to form a boolean solid.");
    s += dumpBooleanSolid(name, nmspace);
    throwError(s);
  }
 
  if (myTranslation->size() > 0) {
    atts.clear();
    atts = myTranslation->getAttributeSet();
    x = ev.eval(nmspace, atts.find("x")->second);
    y = ev.eval(nmspace, atts.find("y")->second);
    z = ev.eval(nmspace, atts.find("z")->second);
  }
 
  if (myrRotation->size() > 0) {
    ddrot = DDRotation(myrRotation->getDDName(nmspace));
  }
 
  DDSolid theSolid;
 
  if (name == "UnionSolid") {
    theSolid =
        DDSolidFactory::unionSolid(getDDName(nmspace), DDSolid(ddn1), DDSolid(ddn2), DDTranslation(x, y, z), ddrot);
  } else if (name == "SubtractionSolid") {
    theSolid =
        DDSolidFactory::subtraction(getDDName(nmspace), DDSolid(ddn1), DDSolid(ddn2), DDTranslation(x, y, z), ddrot);
  } else if (name == "IntersectionSolid") {
    theSolid =
        DDSolidFactory::intersection(getDDName(nmspace), DDSolid(ddn1), DDSolid(ddn2), DDTranslation(x, y, z), ddrot);
  } else {
    throw cms::Exception("DDException")
        << "DDLBooleanSolid was asked to do something other than Union-, Subtraction- or IntersectionSolid?";
  }
 
  DDLSolid::setReference(nmspace, cpv);
 
  // clear all "children" and attributes
  myTranslation->clear();
  myrRotation->clear();
  myrSolid->clear();
  clear();
}

References DDXMLElement::clear(), dumpBooleanSolid(), ev, DDLElementRegistry::evaluator(), Exception, DDXMLElement::getAttributeSet(), DDXMLElement::getDDName(), DDLElementRegistry::getElement(), DDSolidFactory::intersection(), DDXMLElement::myRegistry_, Skims_PA_cff::name, alignCSCRings::s, DDLSolid::setReference(), AlCaHLTBitMon_QueryRunRegistry::string, DDSolidFactory::subtraction(), DDXMLElement::throwError(), DDSolidFactory::unionSolid(), x, y, and z.