DDLAlgorithm Class Reference

DDLAlgorithm processes Algorithm elements. More...

#include <DDLAlgorithm.h>

Inheritance diagram for DDLAlgorithm:

Public Member Functions
	DDLAlgorithm (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 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

DDLAlgorithm processes Algorithm elements.

Author

Michael Case

DDLAlgorithm.h - description

begin: Saturday November 29, 2003 email: case@.nosp@m.ucdh.nosp@m.ep.uc.nosp@m.davi.nosp@m.s.edu

This element is used to algorithmically create and position detector LogicalParts.

Definition at line 25 of file DDLAlgorithm.h.

Constructor & Destructor Documentation

DDLAlgorithm::DDLAlgorithm

(

DDLElementRegistry *

myreg

)

Definition at line 18 of file DDLAlgorithm.cc.

: DDXMLElement(myreg) {}

Member Function Documentation

void DDLAlgorithm::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 DDLAlgorithm.cc.

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

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

void DDLAlgorithm::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 DDLAlgorithm.cc.

References DDXMLElement::clear(), ClhepEvaluator::eval(), DDLElementRegistry::evaluator(), DDAlgorithmHandler::execute(), DDXMLElement::getAttributeSet(), DDXMLElement::getDDName(), DDLElementRegistry::getElement(), mps_fire::i, DDAlgorithmHandler::initialize(), and DDXMLElement::myRegistry_.

                                                                                                     {
  auto myNumeric = myRegistry_->getElement("Numeric");
  auto myString = myRegistry_->getElement("String");
  auto myVector = myRegistry_->getElement("Vector");
  auto myMap = myRegistry_->getElement("Map");
  auto myrParent = myRegistry_->getElement("rParent");

  DDName algoName(getDDName(nmspace));
  DDLogicalPart lp(DDName(myrParent->getDDName(nmspace)));
  DDXMLAttribute atts;

  // handle all Numeric elements in the Algorithm.
  DDNumericArguments nArgs;
  size_t i = 0;
  for (; i < myNumeric->size(); ++i) {
    atts = myNumeric->getAttributeSet(i);
    nArgs[atts.find("name")->second] = myRegistry_->evaluator().eval(nmspace, atts.find("value")->second);
  }

  DDStringArguments sArgs;
  for (i = 0; i < myString->size(); ++i) {
    atts = myString->getAttributeSet(i);
    sArgs[atts.find("name")->second] = atts.find("value")->second;
  }

  DDAlgorithmHandler handler;
  atts = getAttributeSet();
  handler.initialize(algoName,
                     lp,
                     nArgs,
                     static_cast<DDLVector*>(myVector.get())->getMapOfVectors(),
                     static_cast<DDLMap*>(myMap.get())->getMapOfMaps(),
                     sArgs,
                     static_cast<DDLVector*>(myVector.get())->getMapOfStrVectors());
  handler.execute(cpv);

  // clear used/referred to elements.
  myString->clear();
  myNumeric->clear();
  myVector->clear();
  myMap->clear();
  myrParent->clear();
  clear();
}