DDLCompositeMaterial Class Reference

DDLCompositeMaterial processes all CompositeMaterial elements. More...

#include <DDLCompositeMaterial.h>

Inheritance diagram for DDLCompositeMaterial:

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 DDXMLAttribute &	getAttributeSet (size_t aIndex=0) const
	Get a "row" of attributes, i.e. one attribute set. More...
virtual const 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
DDLElementRegistry *	myRegistry_

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

(

DDLElementRegistry *

myreg

)

Definition at line 16 of file DDLCompositeMaterial.cc.

: DDLMaterial(myreg) {}

Member Function Documentation

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.

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

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

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.

References DDMaterial::addMaterial(), DDXMLElement::clear(), ev, ClhepEvaluator::eval(), 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().

                                                                                                             {
  ClhepEvaluator& ev = myRegistry_->evaluator();
  DDXMLAttribute atts = getAttributeSet();

  DDName ddn = getDDName(nmspace);
  DDMaterial mat;

  mat = DDMaterial(ddn, ev.eval(nmspace, atts.find("density")->second));

  // Get references to relevant DDL elements that are needed.
  auto myMF = myRegistry_->getElement("MaterialFraction");
  auto myrMaterial = myRegistry_->getElement("rMaterial");

  // Get the names from those elements and also the namespace for the reference element.
  // The parent element CompositeMaterial MUST be in the same namespace as this fraction.
  // additionally, because it is NOT a reference, we do not try to dis-entangle the namespace.
  // That is, we do not use the getName() which searches the name for a colon, but instead use
  // the "raw" name attribute.

  // TO DO:  sfractions assumes that the values are "mixture by weight" (I think)
  // we need to retrieve the fraction attributes and then check the method
  // attribute of the CompositeMaterial to determine if the numbers go straight
  // in to the DDCore or if the numbers need to be manipulated so that the
  // sfractions are really mixtures by weight going into the DDCore.  Otherwise,
  // the DDCore has to know which are which and right now it does not.

  if (myMF->size() != myrMaterial->size()) {
    std::string msg = "/nDDLCompositeMaterial::processElement found that the ";
    msg += "number of MaterialFractions does not match the number ";
    msg += "of rMaterial names for ";
    msg += ddn.ns() + ":" + ddn.name() + ".";
    throwError(msg);
  }
  for (size_t i = 0; i < myrMaterial->size(); ++i) {
    atts = myMF->getAttributeSet(i);
    mat.addMaterial(myrMaterial->getDDName(nmspace, "name", i), ev.eval(nmspace, atts.find("fraction")->second));
  }
  // clears and sets new reference to THIS material.
  DDLMaterial::setReference(nmspace, cpv);
  myMF->clear();
  clear();
}