DDLDivision Class Reference

DDLDivision processes Division elements. More...

#include <DDLDivision.h>

Inheritance diagram for DDLDivision:

Public Member Functions
	DDLDivision (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...
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
DDDividedGeometryObject *	makeDivider (const DDDivision &div, DDCompactView *cpv)

Additional Inherited Members
Protected Attributes inherited from DDXMLElement
DDLElementRegistry *	myRegistry_

Detailed Description

DDLDivision processes Division elements.

Author

Michael Case

DDLDivision.h - description

begin: Friday, April 23, 2004 email: case@.nosp@m.ucdh.nosp@m.ep.uc.nosp@m.davi.nosp@m.s.edu

Definition at line 27 of file DDLDivision.h.

Constructor & Destructor Documentation

DDLDivision()

DDLDivision::DDLDivision

(

DDLElementRegistry *

myreg

)

Definition at line 26 of file DDLDivision.cc.

: DDXMLElement(myreg) {}

Member Function Documentation

makeDivider()

DDDividedGeometryObject * DDLDivision::makeDivider ( const DDDivision &  div, DDCompactView *  cpv  )

private

Definition at line 83 of file DDLDivision.cc.

                                                                                           {
  DDDividedGeometryObject* dg = nullptr;
 
  switch (div.parent().solid().shape()) {
    case DDSolidShape::ddbox:
      if (div.axis() == DDAxes::x)
        dg = new DDDividedBoxX(div, cpv);
      else if (div.axis() == DDAxes::y)
        dg = new DDDividedBoxY(div, cpv);
      else if (div.axis() == DDAxes::z)
        dg = new DDDividedBoxZ(div, cpv);
      else {
        std::string s = "DDLDivision can not divide a ";
        s += DDSolidShapesName::name(div.parent().solid().shape());
        s += " along axis " + DDAxesNames::name(div.axis());
        s += ".";
        s += "\n    name= " + div.name().ns() + ":" + div.name().name();
        s += "\n    parent= " + div.parent().name().ns() + ":" + div.parent().name().name();
        throwError(s);
      }
      break;
 
    case DDSolidShape::ddtubs:
      if (div.axis() == DDAxes::rho)
        dg = new DDDividedTubsRho(div, cpv);
      else if (div.axis() == DDAxes::phi)
        dg = new DDDividedTubsPhi(div, cpv);
      else if (div.axis() == DDAxes::z)
        dg = new DDDividedTubsZ(div, cpv);
      else {
        std::string s = "DDLDivision can not divide a ";
        s += DDSolidShapesName::name(div.parent().solid().shape());
        s += " along axis " + DDAxesNames::name(div.axis());
        s += ".";
        s += "\n    name= " + div.name().ns() + ":" + div.name().name();
        s += "\n    parent= " + div.parent().name().ns() + ":" + div.parent().name().name();
        throwError(s);
      }
      break;
 
    case DDSolidShape::ddtrap:
      if (div.axis() == DDAxes::x)
        dg = new DDDividedTrdX(div, cpv);
      else if (div.axis() == DDAxes::y)
        dg = new DDDividedTrdY(div, cpv);
      else if (div.axis() == DDAxes::z)
        dg = new DDDividedTrdZ(div, cpv);
      else {
        std::string s = "DDLDivision can not divide a ";
        s += DDSolidShapesName::name(div.parent().solid().shape());
        s += " along axis ";
        s += DDAxesNames::name(div.axis());
        s += ".";
        s += "\n    name= " + div.name().ns() + ":" + div.name().name();
        s += "\n    parent= " + div.parent().name().ns() + ":" + div.parent().name().name();
        throwError(s);
      }
      break;
 
    case DDSolidShape::ddcons:
      if (div.axis() == DDAxes::rho)
        dg = new DDDividedConsRho(div, cpv);
      else if (div.axis() == DDAxes::phi)
        dg = new DDDividedConsPhi(div, cpv);
      else if (div.axis() == DDAxes::z)
        dg = new DDDividedConsZ(div, cpv);
      else {
        std::string s = "DDLDivision can not divide a ";
        s += DDSolidShapesName::name(div.parent().solid().shape());
        s += " along axis " + DDAxesNames::name(div.axis());
        s += ".";
        s += "\n    name= " + div.name().ns() + ":" + div.name().name();
        s += "\n    parent= " + div.parent().name().ns() + ":" + div.parent().name().name();
        throwError(s);
      }
      break;
 
    case DDSolidShape::ddpolycone_rrz:
      if (div.axis() == DDAxes::rho)
        dg = new DDDividedPolyconeRho(div, cpv);
      else if (div.axis() == DDAxes::phi)
        dg = new DDDividedPolyconePhi(div, cpv);
      else if (div.axis() == DDAxes::z)
        dg = new DDDividedPolyconeZ(div, cpv);
      else {
        std::string s = "DDLDivision can not divide a ";
        s += DDSolidShapesName::name(div.parent().solid().shape());
        s += " along axis ";
        s += DDAxesNames::name(div.axis());
        s += ".";
        s += "\n    name= " + div.name().ns() + ":" + div.name().name();
        s += "\n    parent= " + div.parent().name().ns() + ":" + div.parent().name().name();
        throwError(s);
      }
      break;
 
    case DDSolidShape::ddpolyhedra_rrz:
      if (div.axis() == DDAxes::rho)
        dg = new DDDividedPolyhedraRho(div, cpv);
      else if (div.axis() == DDAxes::phi)
        dg = new DDDividedPolyhedraPhi(div, cpv);
      else if (div.axis() == DDAxes::z)
        dg = new DDDividedPolyhedraZ(div, cpv);
      else {
        std::string s = "DDLDivision can not divide a ";
        s += DDSolidShapesName::name(div.parent().solid().shape());
        s += " along axis ";
        s += DDAxesNames::name(div.axis());
        s += ".";
        s += "\n    name= " + div.name().ns() + ":" + div.name().name();
        s += "\n    parent= " + div.parent().name().ns() + ":" + div.parent().name().name();
        throwError(s);
      }
      break;
 
    case DDSolidShape::ddpolycone_rz:
    case DDSolidShape::ddpolyhedra_rz: {
      std::string s = "ERROR:  A Polycone or Polyhedra can not be divided on any axis if it's\n";
      s += "original definition used r and z instead of ZSections. This has\n";
      s += "not (yet) been implemented.";
      s += "\n    name= " + div.name().ns() + ":" + div.name().name();
      s += "\n    parent= " + div.parent().name().ns() + ":" + div.parent().name().name();
    } break;
 
    case DDSolidShape::ddunion:
    case DDSolidShape::ddsubtraction:
    case DDSolidShape::ddintersection:
    case DDSolidShape::ddshapeless:
    case DDSolidShape::ddpseudotrap:
    case DDSolidShape::ddtrunctubs:
    case DDSolidShape::dd_not_init: {
      std::string s = "DDLDivision can not divide a ";
      s += DDSolidShapesName::name(div.parent().solid().shape());
      s += " at all (yet?).  Requested axis was ";
      s += DDAxesNames::name(div.axis());
      s += ".\n";
      throwError(s);
    } break;
    default:
      break;
  }
  return dg;
}

References DDDivision::axis(), dd_not_init, ddbox, ddcons, ddintersection, ddpolycone_rrz, ddpolycone_rz, ddpolyhedra_rrz, ddpolyhedra_rz, ddpseudotrap, ddshapeless, ddsubtraction, ddtrap, ddtrunctubs, ddtubs, ddunion, DDAxesNames::name(), DDSolidShapesName::name(), DDName::name(), DDBase< N, C >::name(), DDName::ns(), DDDivision::parent(), phi, rho, alignCSCRings::s, DDSolid::shape(), DDLogicalPart::solid(), AlCaHLTBitMon_QueryRunRegistry::string, DDXMLElement::throwError(), x, y, and z.

Referenced by processElement().

preProcessElement()

void DDLDivision::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 28 of file DDLDivision.cc.

{}

processElement()

void DDLDivision::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 30 of file DDLDivision.cc.

                                                                                                    {
  DDXMLAttribute atts = getAttributeSet();
 
  DDName parent = getDDName(nmspace, "parent");
  ClhepEvaluator& ev = myRegistry_->evaluator();
  size_t ax = 0;
  while (DDAxesNames::name(DDAxes(ax)) != atts.find("axis")->second && DDAxesNames::name(DDAxes(ax)) != "undefined")
    ++ax;
 
  DDLogicalPart lp(parent);
  if (!lp.isDefined().second || !lp.solid().isDefined().second) {
    std::string em("DetectorDescription Parser DDLDivision::processElement(...) failed.");
    em += "  The solid of the parent logical part MUST be defined before the Division is made.";
    em += "\n    name= " + getDDName(nmspace).ns() + ":" + getDDName(nmspace).name();
    em += "\n    parent= " + parent.ns() + ":" + parent.name();
    throwError(em);
  }
 
  DDDivision div;
 
  if (atts.find("nReplicas") != atts.end() && atts.find("width") != atts.end() && atts.find("offset") != atts.end()) {
    div = DDDivision(getDDName(nmspace),
                     parent,
                     DDAxes(ax),
                     int(ev.eval(nmspace, atts.find("nReplicas")->second)),
                     ev.eval(nmspace, atts.find("width")->second),
                     ev.eval(nmspace, atts.find("offset")->second));
  } else if (atts.find("nReplicas") != atts.end() && atts.find("offset") != atts.end()) {
    div = DDDivision(getDDName(nmspace),
                     parent,
                     DDAxes(ax),
                     int(ev.eval(nmspace, atts.find("nReplicas")->second)),
                     ev.eval(nmspace, atts.find("offset")->second));
  } else if (atts.find("width") != atts.end() && atts.find("offset") != atts.end()) {
    div = DDDivision(getDDName(nmspace),
                     parent,
                     DDAxes(ax),
                     ev.eval(nmspace, atts.find("width")->second),
                     ev.eval(nmspace, atts.find("offset")->second));
  } else {
    std::string em("DetectorDescription Parser DDLDivision::processElement(...) failed.");
    em += "  Allowed combinations are attributes width&offset OR nReplicas&offset OR nReplicas&width&offset.";
    em += "\n    name= " + getDDName(nmspace).ns() + ":" + getDDName(nmspace).name();
    em += "\n    parent= " + parent.ns() + ":" + parent.name();
    throwError(em);
  }
  DDDividedGeometryObject* dg = makeDivider(div, &cpv);
  dg->execute();
  delete dg;
 
  clear();
}

References DDXMLElement::clear(), ev, DDLElementRegistry::evaluator(), DDDividedGeometryObject::execute(), DDXMLElement::getAttributeSet(), DDXMLElement::getDDName(), DDBase< N, C >::isDefined(), makeDivider(), DDXMLElement::myRegistry_, DDAxesNames::name(), DDName::name(), DDName::ns(), DDXMLElement::parent(), DDLogicalPart::solid(), AlCaHLTBitMon_QueryRunRegistry::string, and DDXMLElement::throwError().