CMS 3D CMS Logo
List of all members | Public Member Functions
DDLPolyGenerator Class Referencefinal

DDLPolyGenerator processes DDL XML Polycone and DDL XML Polyhedra elements. More...

#include <DDLPolyGenerator.h>

Inheritance diagram for DDLPolyGenerator:
DDLSolid DDXMLElement

Public Member Functions

 DDLPolyGenerator (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...
 

Additional Inherited Members

- Protected Attributes inherited from DDXMLElement
DDLElementRegistry * myRegistry_
 

Detailed Description

DDLPolyGenerator processes DDL XML Polycone and DDL XML Polyhedra elements.

Author
Michael Case

DDLPolyGenerator.h - description

begin: Mon Aug 5 2002 email: case@.nosp@m.ucdh.nosp@m.ep.uc.nosp@m.davi.nosp@m.s.edu

The PolyGenerator element uses RZPoint elements. The DDLRZPoint can return the r and z std::vectors with the points needed to form the polycone. The RZPoint "accumulator" is also used by the Polyhedra and Polycone elements, and could be used anywhere a pair of std::vectors of r and z values are needed.

Definition at line 28 of file DDLPolyGenerator.h.

Constructor & Destructor Documentation

◆ DDLPolyGenerator()

DDLPolyGenerator::DDLPolyGenerator ( DDLElementRegistry *  myreg)

Definition at line 15 of file DDLPolyGenerator.cc.

15 : DDLSolid(myreg) {}

Member Function Documentation

◆ preProcessElement()

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

17  {
18  myRegistry_->getElement("RZPoint")->clear();
19  myRegistry_->getElement("ZSection")->clear();
20 }

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

◆ processElement()

void DDLPolyGenerator::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 25 of file DDLPolyGenerator.cc.

25  {
26  auto myRZPoints = myRegistry_->getElement("RZPoint");
27  auto myZSection = myRegistry_->getElement("ZSection");
28 
29  ClhepEvaluator& ev = myRegistry_->evaluator();
30  DDXMLAttribute atts;
31 
32  // get z and r
33  std::vector<double> z, r, x, y;
34  for (size_t i = 0; i < myRZPoints->size(); ++i) {
35  atts = myRZPoints->getAttributeSet(i);
36  z.emplace_back(ev.eval(nmspace, atts.find("z")->second));
37  r.emplace_back(ev.eval(nmspace, atts.find("r")->second));
38  }
39 
40  // if z is empty, then it better not have been a polycone defined
41  // by RZPoints, instead, it must be a ZSection defined polycone.
42  if (z.empty()) {
43  // get zSection information, note, we already have a z declared above
44  // and we will use r for rmin. In this case, no use "trying" because
45  // it better be there!
46  std::vector<double> rMax;
47 
48  for (size_t i = 0; i < myZSection->size(); ++i) {
49  atts = myZSection->getAttributeSet(i);
50  z.emplace_back(ev.eval(nmspace, atts.find("z")->second));
51  r.emplace_back(ev.eval(nmspace, atts.find("rMin")->second));
52  rMax.emplace_back(ev.eval(nmspace, atts.find("rMax")->second));
53  }
54  atts = getAttributeSet();
55  if (name == "Polycone") // defined with ZSections
56  {
57  DDSolid ddpolycone = DDSolidFactory::polycone(getDDName(nmspace),
58  ev.eval(nmspace, atts.find("startPhi")->second),
59  ev.eval(nmspace, atts.find("deltaPhi")->second),
60  z,
61  r,
62  rMax);
63  } else if (name == "Polyhedra") // defined with ZSections
64  {
65  DDSolid ddpolyhedra = DDSolidFactory::polyhedra(getDDName(nmspace),
66  int(ev.eval(nmspace, atts.find("numSide")->second)),
67  ev.eval(nmspace, atts.find("startPhi")->second),
68  ev.eval(nmspace, atts.find("deltaPhi")->second),
69  z,
70  r,
71  rMax);
72  }
73 
74  } else if (name == "Polycone") // defined with RZPoints
75  {
76  atts = getAttributeSet();
77  DDSolid ddpolycone = DDSolidFactory::polycone(getDDName(nmspace),
78  ev.eval(nmspace, atts.find("startPhi")->second),
79  ev.eval(nmspace, atts.find("deltaPhi")->second),
80  z,
81  r);
82  } else if (name == "Polyhedra") // defined with RZPoints
83  {
84  atts = getAttributeSet();
85  DDSolid ddpolyhedra = DDSolidFactory::polyhedra(getDDName(nmspace),
86  int(ev.eval(nmspace, atts.find("numSide")->second)),
87  ev.eval(nmspace, atts.find("startPhi")->second),
88  ev.eval(nmspace, atts.find("deltaPhi")->second),
89  z,
90  r);
91  } else {
92  std::string msg = "\nDDLPolyGenerator::processElement was called with incorrect name of solid: " + name;
93  throwError(msg);
94  }
95  DDLSolid::setReference(nmspace, cpv);
96 
97  // clear out RZPoint element accumulator and ZSections
98  myRZPoints->clear();
99  myZSection->clear();
100  clear();
101 }

References DDXMLElement::clear(), ev, DDLElementRegistry::evaluator(), DDXMLElement::getAttributeSet(), DDXMLElement::getDDName(), DDLElementRegistry::getElement(), mps_fire::i, mps_check::msg, DDXMLElement::myRegistry_, Skims_PA_cff::name, DDSolidFactory::polycone(), DDSolidFactory::polyhedra(), alignCSCRings::r, photonAnalyzer_cfi::rMax, DDLSolid::setReference(), AlCaHLTBitMon_QueryRunRegistry::string, DDXMLElement::throwError(), x, y, and z.

DDXMLElement::clear
virtual void clear(void)
clear this element's contents.
Definition: DDXMLElement.cc:40
DDAxes::y
photonAnalyzer_cfi.rMax
rMax
Definition: photonAnalyzer_cfi.py:91
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
DDLSolid::setReference
void setReference(const std::string &nmspace, DDCompactView &cpv)
Definition: DDLSolid.cc:13
ClhepEvaluator
Definition: ClhepEvaluator.h:8
mps_check.msg
tuple msg
Definition: mps_check.py:285
DDAxes::x
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
DDSolidFactory::polyhedra
static DDSolid polyhedra(const DDName &name, int sides, double startPhi, double deltaPhi, const std::vector< double > &z, const std::vector< double > &rmin, const std::vector< double > &rmax)
Creates a polyhedra (refere to Geant3 or Geant4 documentation)
Definition: DDSolid.cc:565
DDAxes::z
cms::DDSolidShape::ddpolyhedra
DDXMLAttribute
std::map< std::string, std::string > DDXMLAttribute
Definition: DDXMLElement.h:45
cms::DDSolidShape::ddpolycone
DDSolidFactory::polycone
static DDSolid polycone(const DDName &name, double startPhi, double deltaPhi, const std::vector< double > &z, const std::vector< double > &rmin, const std::vector< double > &rmax)
Creates a polycone (refere to Geant3 or Geant4 documentation)
Definition: DDSolid.cc:551
AlCaHLTBitMon_QueryRunRegistry.string
string string
Definition: AlCaHLTBitMon_QueryRunRegistry.py:256
alignCSCRings.r
r
Definition: alignCSCRings.py:93
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
DDLSolid::DDLSolid
DDLSolid(DDLElementRegistry *myreg)
Constructor.
Definition: DDLSolid.cc:11
ev
bool ev
Definition: Hydjet2Hadronizer.cc:97
Skims_PA_cff.name
name
Definition: Skims_PA_cff.py:17
DDSolid
A DDSolid represents the shape of a part.
Definition: DDSolid.h:39
DDXMLElement::myRegistry_
DDLElementRegistry * myRegistry_
Definition: DDXMLElement.h:173
Generated for CMSSW Reference Manual by doxygen 1.8.16