CMS 3D CMS Logo

List of all members | Public Member Functions
DDLCompositeMaterial Class Referencefinal

DDLCompositeMaterial processes all CompositeMaterial elements. More...

#include <DDLCompositeMaterial.h>

Inheritance diagram for DDLCompositeMaterial:
DDLMaterial DDXMLElement

Public Member Functions

 DDLCompositeMaterial (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 DDLMaterial
 DDLMaterial (DDLElementRegistry *myreg)
 
virtual 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 DDXMLAttributegetAttributeSet (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...
 

Additional Inherited Members

- Protected Attributes inherited from DDXMLElement
DDLElementRegistrymyRegistry_
 

Detailed Description

DDLCompositeMaterial processes all CompositeMaterial elements.

Author
Michael Case

DDLCompositeMaterial.h - description

begin: Wed Oct 31 2001 email: case@.nosp@m.ucdh.nosp@m.ep.uc.nosp@m.davi.nosp@m.s.edu

This is the processor for CompositeMaterial DDL elements.

The CompositeMaterial is an element that contains other elements. In particular, it contains rMaterial elements which are references either
to other Composite or Elementary materials.

Definition at line 31 of file DDLCompositeMaterial.h.

Constructor & Destructor Documentation

◆ DDLCompositeMaterial()

DDLCompositeMaterial::DDLCompositeMaterial ( DDLElementRegistry myreg)

Definition at line 16 of file DDLCompositeMaterial.cc.

16 : DDLMaterial(myreg) {}

Member Function Documentation

◆ preProcessElement()

void DDLCompositeMaterial::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 20 of file DDLCompositeMaterial.cc.

20  {
21  // fyi: no need to clear MaterialFraction because it is cleared at the end of each
22  // CompositeMaterial
23  myRegistry_->getElement("rMaterial")->clear();
24 }

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

◆ processElement()

void DDLCompositeMaterial::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 26 of file DDLCompositeMaterial.cc.

26  {
29 
30  DDName ddn = getDDName(nmspace);
31  DDMaterial mat;
32 
33  mat = DDMaterial(ddn, ev.eval(nmspace, atts.find("density")->second));
34 
35  // Get references to relevant DDL elements that are needed.
36  auto myMF = myRegistry_->getElement("MaterialFraction");
37  auto myrMaterial = myRegistry_->getElement("rMaterial");
38 
39  // Get the names from those elements and also the namespace for the reference element.
40  // The parent element CompositeMaterial MUST be in the same namespace as this fraction.
41  // additionally, because it is NOT a reference, we do not try to dis-entangle the namespace.
42  // That is, we do not use the getName() which searches the name for a colon, but instead use
43  // the "raw" name attribute.
44 
45  // TO DO: sfractions assumes that the values are "mixture by weight" (I think)
46  // we need to retrieve the fraction attributes and then check the method
47  // attribute of the CompositeMaterial to determine if the numbers go straight
48  // in to the DDCore or if the numbers need to be manipulated so that the
49  // sfractions are really mixtures by weight going into the DDCore. Otherwise,
50  // the DDCore has to know which are which and right now it does not.
51 
52  if (myMF->size() != myrMaterial->size()) {
53  std::string msg = "/nDDLCompositeMaterial::processElement found that the ";
54  msg += "number of MaterialFractions does not match the number ";
55  msg += "of rMaterial names for ";
56  msg += ddn.ns() + ":" + ddn.name() + ".";
57  throwError(msg);
58  }
59  for (size_t i = 0; i < myrMaterial->size(); ++i) {
60  atts = myMF->getAttributeSet(i);
61  mat.addMaterial(myrMaterial->getDDName(nmspace, "name", i), ev.eval(nmspace, atts.find("fraction")->second));
62  }
63  // clears and sets new reference to THIS material.
64  DDLMaterial::setReference(nmspace, cpv);
65  myMF->clear();
66  clear();
67 }

References DDMaterial::addMaterial(), DDXMLElement::clear(), ev, DDLElementRegistry::evaluator(), DDXMLElement::getAttributeSet(), DDXMLElement::getDDName(), DDLElementRegistry::getElement(), mps_fire::i, mps_check::msg, DDXMLElement::myRegistry_, DDName::name(), DDName::ns(), DDLMaterial::setReference(), AlCaHLTBitMon_QueryRunRegistry::string, and DDXMLElement::throwError().

DDXMLElement::clear
virtual void clear(void)
clear this element's contents.
Definition: DDXMLElement.cc:40
mps_fire.i
i
Definition: mps_fire.py:428
DDXMLElement::throwError
void throwError(const std::string &keyMessage) const
format std::string for throw an error.
Definition: DDXMLElement.cc:209
DDName
DDName is used to identify DDD entities uniquely.
Definition: DDName.h:17
ClhepEvaluator
Definition: ClhepEvaluator.h:8
mps_check.msg
tuple msg
Definition: mps_check.py:285
DDXMLElement::getAttributeSet
virtual const DDXMLAttribute & getAttributeSet(size_t aIndex=0) const
Get a "row" of attributes, i.e. one attribute set.
Definition: DDXMLElement.cc:54
DDLElementRegistry::evaluator
ClhepEvaluator & evaluator()
Definition: DDLElementRegistry.h:42
DDMaterial
DDMaterial is used to define and access material information.
Definition: DDMaterial.h:45
DDXMLAttribute
std::map< std::string, std::string > DDXMLAttribute
Definition: DDXMLElement.h:45
DDName::name
const std::string & name() const
Returns the name.
Definition: DDName.cc:41
DDLMaterial::setReference
virtual void setReference(const std::string &nmspace, DDCompactView &cpv)
Definition: DDLMaterial.cc:13
AlCaHLTBitMon_QueryRunRegistry.string
string string
Definition: AlCaHLTBitMon_QueryRunRegistry.py:256
DDXMLElement::getDDName
const virtual DDName getDDName(const std::string &defaultNS, const std::string &attname=std::string("name"), size_t aIndex=0)
Definition: DDXMLElement.cc:56
DDLElementRegistry::getElement
std::shared_ptr< DDXMLElement > getElement(const std::string &name)
THE most important part. Getting the pointer to a given element type.
Definition: DDLElementRegistry.cc:43
DDName::ns
const std::string & ns() const
Returns the namespace.
Definition: DDName.cc:52
DDLMaterial::DDLMaterial
DDLMaterial(DDLElementRegistry *myreg)
Definition: DDLMaterial.cc:11
ev
bool ev
Definition: Hydjet2Hadronizer.cc:97
DDXMLElement::myRegistry_
DDLElementRegistry * myRegistry_
Definition: DDXMLElement.h:173
DDMaterial::addMaterial
int addMaterial(const DDMaterial &m, double fm)
adds a material to the mixture proportional to its fraction-mass fm.
Definition: DDMaterial.cc:63