This is a base class for processing XML elements in the DDD. More...
#include <DDXMLElement.h>
Public Member Functions | |
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... | |
virtual void | preProcessElement (const std::string &name, const std::string &nmspace, DDCompactView &cpv) |
Called by loadAttributes AFTER attributes are loaded. More... | |
virtual void | processElement (const std::string &name, const std::string &nmspace, DDCompactView &cpv) |
Processing the element. 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... | |
Protected Attributes | |
DDLElementRegistry * | myRegistry_ |
Private Member Functions | |
void | appendAttributes (std::vector< std::string > &tv, const std::string &name) |
behind the scenes appending to pAttributes... More... | |
Private Attributes | |
AttrAccumType | attributeAccumulator_ |
std::vector< DDXMLAttribute > | attributes_ |
bool | autoClear_ |
std::string | myElement_ |
std::vector< DDXMLAttribute >::const_iterator | myIter_ |
std::string | parentElement_ |
std::vector< std::string > | text_ |
Friends | |
std::ostream & | operator<< (std::ostream &os, const DDXMLElement &element) |
This is a base class for processing XML elements in the DDD.
DDXMLElement
Component of DDL XML Parsing
A DDXMLElement stores all the attributes and text of an XML element. It is designed to accumulate this information unless cleared. In other words, it accumulates sets of attributes, and allows the appending of text indefinitely, as opposed to, say, creating another class which is designed to hold a std::vector of single element information. This is contrary to the way that XML normally defines an element, but for DDL, this works fine.
One of the things that one needs to build in to each subclass is when an element needs to be cleared. For some, emptying the std::vectors should happen at the end (of the processElement method). For some, clearing is ONLY done by the parent. For example, SpecPar and its child PartSelector. or Polyhedra and its child ZSection. In some cases elements can be in one or more parent elements as well as on their own (Vector, Map). For these the processing currently depends on the parent so one must clear only as appropriate.
Definition at line 48 of file DDXMLElement.h.
DDXMLElement::DDXMLElement | ( | DDLElementRegistry * | myreg | ) |
DDXMLElement::DDXMLElement | ( | DDLElementRegistry * | myreg, |
const bool & | clearme | ||
) |
|
virtualdefault |
Destructor.
|
private |
behind the scenes appending to pAttributes...
Definition at line 173 of file DDXMLElement.cc.
References attributes_, end(), mps_fire::i, and Skims_PA_cff::name.
Referenced by getVectorAttribute().
void DDXMLElement::appendText | ( | const std::string & | inText | ) |
append to the current (i.e. most recently added)
Definition at line 134 of file DDXMLElement.cc.
References mps_check::msg, AlCaHLTBitMon_QueryRunRegistry::string, text_, and throwError().
|
virtual |
Definition at line 186 of file DDXMLElement.cc.
References attributes_, and myIter_.
|
virtual |
clear this element's contents.
Definition at line 40 of file DDXMLElement.cc.
References attributeAccumulator_, attributes_, and text_.
Referenced by DDLVector::clearall(), DDLPgonGenerator::processElement(), DDLRotationSequence::processElement(), DDLSpecPar::processElement(), DDLAlgorithm::processElement(), DDLRotationByAxis::processElement(), DDLString::processElement(), DDLPosPart::processElement(), DDLDivision::processElement(), DDLBooleanSolid::processElement(), DDLPolyGenerator::processElement(), DDLRotationAndReflection::processElement(), DDLElementaryMaterial::processElement(), DDLNumeric::processElement(), DDLVector::processElement(), DDLCompositeMaterial::processElement(), DDLLogicalPart::processElement(), DDLMap::processElement(), processElement(), DDLMaterial::setReference(), and DDLSolid::setReference().
|
virtual |
Definition at line 191 of file DDXMLElement.cc.
References attributes_, and myIter_.
Referenced by appendAttributes(), Types.LuminosityBlockRange::cppID(), Types.EventRange::cppID(), DDLVector::do_makeDouble(), DDLMap::do_makeDouble(), DDLMap::do_makeName(), DDLVector::do_makeString(), get(), DDLVector::parse_numbers(), and DDLVector::parse_strings().
|
virtual |
Returns a specific value from the aIndex set of attributes.
Definition at line 85 of file DDXMLElement.cc.
References attributes_, end(), ALPAKA_ACCELERATOR_NAMESPACE::vertexFinder::it, mps_check::msg, Skims_PA_cff::name, AlCaHLTBitMon_QueryRunRegistry::string, throwError(), and to_string().
Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), util.rrapi.RRApi::columns(), rrapi.RRApi::columns(), rrapi.RRApi::count(), util.rrapi.RRApi::count(), rrapi.RRApi::data(), util.rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), util.rrapi.RRApi::report(), rrapi.RRApi::report(), rrapi.RRApi::reports(), util.rrapi.RRApi::reports(), rrapi.RRApi::tables(), util.rrapi.RRApi::tables(), util.rrapi.RRApi::tags(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), util.rrapi.RRApi::templates(), util.rrapi.RRApi::workspaces(), and rrapi.RRApi::workspaces().
|
virtual |
Access to attributes by name.
Definition at line 47 of file DDXMLElement.cc.
References attributes_, Skims_PA_cff::name, and AlCaHLTBitMon_QueryRunRegistry::string.
|
virtual |
Get a "row" of attributes, i.e. one attribute set.
Definition at line 54 of file DDXMLElement.cc.
References attributes_.
Referenced by DDLBooleanSolid::dumpBooleanSolid(), DDLRotationAndReflection::isLeftHanded(), DDLRotationAndReflection::makeX(), DDLRotationAndReflection::makeY(), DDLRotationAndReflection::makeZ(), DDLPgonGenerator::processElement(), DDLTubs::processElement(), DDLPseudoTrap::processElement(), DDLTrapezoid::processElement(), DDLTorus::processElement(), DDLEllipticalTube::processElement(), DDLSphere::processElement(), DDLAlgorithm::processElement(), DDLRotationByAxis::processElement(), DDLSpecPar::processElement(), DDLBox::processElement(), DDLCone::processElement(), DDLString::processElement(), DDLElementaryMaterial::processElement(), DDLBooleanSolid::processElement(), DDLPosPart::processElement(), DDLDivision::processElement(), DDLRotationAndReflection::processElement(), DDLPolyGenerator::processElement(), DDLVector::processElement(), DDLNumeric::processElement(), DDLCompositeMaterial::processElement(), DDLLogicalPart::processElement(), DDLMap::processElement(), DDLMaterial::setReference(), and DDLSolid::setReference().
|
virtual |
Definition at line 56 of file DDXMLElement.cc.
References attributes_, mps_check::msg, Skims_PA_cff::name, AlCaHLTBitMon_QueryRunRegistry::string, throwError(), and to_string().
Referenced by DDLRotationAndReflection::isLeftHanded(), DDLPgonGenerator::processElement(), DDLAssembly::processElement(), DDLTubs::processElement(), DDLTrapezoid::processElement(), DDLTorus::processElement(), DDLPseudoTrap::processElement(), DDLEllipticalTube::processElement(), DDLShapelessSolid::processElement(), DDLSphere::processElement(), DDLRotationSequence::processElement(), DDLAlgorithm::processElement(), DDLRotationByAxis::processElement(), DDLSpecPar::processElement(), DDLBox::processElement(), DDLCone::processElement(), DDLString::processElement(), DDLPolyGenerator::processElement(), DDLDivision::processElement(), DDLRotationAndReflection::processElement(), DDLElementaryMaterial::processElement(), DDLBooleanSolid::processElement(), DDLVector::processElement(), DDLNumeric::processElement(), DDLCompositeMaterial::processElement(), DDLLogicalPart::processElement(), and DDLMap::processElement().
const std::string DDXMLElement::getText | ( | size_t | tindex = 0 | ) | const |
retrieve the text blob.
Definition at line 145 of file DDXMLElement.cc.
References mps_check::msg, AlCaHLTBitMon_QueryRunRegistry::string, text_, and throwError().
Referenced by DDLVector::processElement(), and DDLMap::processElement().
|
virtual |
Returns a set of values as a std::vector of strings, given the attribute name.
Definition at line 104 of file DDXMLElement.cc.
References appendAttributes(), attributeAccumulator_, attributes_, and Skims_PA_cff::name.
|
virtual |
gotText()? kind of like gotMilk? Yes = text has already been encountered.
Definition at line 153 of file DDXMLElement.cc.
References text_.
|
virtual |
Have any elements of this type been encountered but not processed?
Definition at line 207 of file DDXMLElement.cc.
References attributes_, and funct::true.
Referenced by plotting.Plot::clone().
void DDXMLElement::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.
The loadAttributes method loads the attributes of the element into a std::map<std::string, std::string> which is used to store Name-Value pairs. It takes as input two std::vectors of strings containing "synchronized" names and values.
In the SAX2 based calling process, this is done on a startElement event.
Definition at line 23 of file DDXMLElement.cc.
References attributes_, mps_fire::i, names, preProcessElement(), and contentValuesCheck::values.
Referenced by DDLRotationByAxis::processElement().
void DDXMLElement::loadText | ( | const std::string & | inText | ) |
Used to load both text and XML comments into this object.
At the current time this is done simply as a way for the user of this class to accumulate text and/or comments as std::vector of strings, each one matching the std::vector of attributes. Therefore loadText starts a new text storage.
Definition at line 132 of file DDXMLElement.cc.
References text_.
Referenced by processElement().
std::vector< DDXMLAttribute >::const_iterator & DDXMLElement::operator++ | ( | int | inc | ) |
Allow the elements of this type to be iterated over using ++ operator.
Definition at line 196 of file DDXMLElement.cc.
References myIter_.
const std::string & DDXMLElement::parent | ( | void | ) | const |
access to parent element name
Definition at line 201 of file DDXMLElement.cc.
References parentElement_.
Referenced by DDLRotationByAxis::processElement(), DDLString::processElement(), DDLDivision::processElement(), DDLNumeric::processElement(), DDLVector::processElement(), DDLMap::processElement(), and DDLSolid::setReference().
|
virtual |
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 in DDLMap, DDLLogicalPart, DDLCompositeMaterial, DDLNumeric, DDLPolyGenerator, DDLVector, DDLBooleanSolid, DDLDivision, DDLPosPart, DDLString, DDLAlgorithm, DDLRotationByAxis, DDLShapelessSolid, DDLRotationSequence, DDLAssembly, and DDLPgonGenerator.
Definition at line 20 of file DDXMLElement.cc.
Referenced by loadAttributes().
|
virtual |
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 in DDLMap, DDLLogicalPart, DDLCompositeMaterial, DDLNumeric, DDLVector, DDLBooleanSolid, DDLDivision, DDLElementaryMaterial, DDLPolyGenerator, DDLPosPart, DDLRotationAndReflection, DDLBox, DDLCone, DDLString, DDLAlgorithm, DDLRotationByAxis, DDLSpecPar, DDLRotationSequence, DDLEllipticalTube, DDLShapelessSolid, DDLSphere, DDLPseudoTrap, DDLTorus, DDLTrapezoid, DDLAssembly, DDLTubs, and DDLPgonGenerator.
Definition at line 126 of file DDXMLElement.cc.
References autoClear_, clear(), loadText(), and AlCaHLTBitMon_QueryRunRegistry::string.
void DDXMLElement::setParent | ( | const std::string & | pename | ) |
Set parent element name to central list of names.
Definition at line 203 of file DDXMLElement.cc.
References parentElement_.
void DDXMLElement::setSelf | ( | const std::string & | sename | ) |
Set self element name to central list of names.
Definition at line 205 of file DDXMLElement.cc.
References myElement_.
|
virtual |
Number of elements accumulated.
Definition at line 184 of file DDXMLElement.cc.
References attributes_.
Referenced by ntupleDataFormat._Collection::__iter__(), and ntupleDataFormat._Collection::__len__().
|
virtual |
Allow for the elements to have their own streaming method, but also provide a default.
Definition at line 164 of file DDXMLElement.cc.
References attributes_, ALPAKA_ACCELERATOR_NAMESPACE::vertexFinder::it, and l1tGTMenu_BTagSeeds_cff::os.
Referenced by operator<<().
void DDXMLElement::throwError | ( | const std::string & | keyMessage | ) | const |
format std::string for throw an error.
Definition at line 209 of file DDXMLElement.cc.
References Exception, mps_check::msg, myElement_, and AlCaHLTBitMon_QueryRunRegistry::string.
Referenced by appendText(), DDLVector::errorOut(), DDLMap::errorOut(), get(), getDDName(), getText(), DDLDivision::makeDivider(), DDLPgonGenerator::processElement(), DDLTubs::processElement(), DDLTrapezoid::processElement(), DDLPolyGenerator::processElement(), DDLDivision::processElement(), DDLRotationAndReflection::processElement(), DDLBooleanSolid::processElement(), DDLCompositeMaterial::processElement(), and DDLRotationByAxis::processOne().
|
friend |
Definition at line 159 of file DDXMLElement.cc.
|
private |
Definition at line 182 of file DDXMLElement.h.
Referenced by clear(), and getVectorAttribute().
|
private |
Definition at line 180 of file DDXMLElement.h.
Referenced by appendAttributes(), begin(), clear(), end(), get(), getAttribute(), getAttributeSet(), getDDName(), getVectorAttribute(), isEmpty(), loadAttributes(), size(), and stream().
|
private |
Definition at line 183 of file DDXMLElement.h.
Referenced by processElement().
|
private |
Definition at line 185 of file DDXMLElement.h.
Referenced by setSelf(), and throwError().
|
private |
Definition at line 184 of file DDXMLElement.h.
Referenced by begin(), end(), and operator++().
|
protected |
Definition at line 173 of file DDXMLElement.h.
Referenced by DDLVector::do_makeDouble(), DDLMap::do_makeDouble(), DDLBooleanSolid::dumpBooleanSolid(), DDLRotationAndReflection::isLeftHanded(), DDLRotationAndReflection::makeX(), DDLRotationAndReflection::makeY(), DDLRotationAndReflection::makeZ(), DDLPgonGenerator::preProcessElement(), DDLAssembly::preProcessElement(), DDLRotationSequence::preProcessElement(), DDLShapelessSolid::preProcessElement(), DDLAlgorithm::preProcessElement(), DDLBooleanSolid::preProcessElement(), DDLPosPart::preProcessElement(), DDLPolyGenerator::preProcessElement(), DDLCompositeMaterial::preProcessElement(), DDLLogicalPart::preProcessElement(), DDLPgonGenerator::processElement(), DDLTubs::processElement(), DDLTorus::processElement(), DDLPseudoTrap::processElement(), DDLTrapezoid::processElement(), DDLSphere::processElement(), DDLEllipticalTube::processElement(), DDLRotationSequence::processElement(), DDLRotationByAxis::processElement(), DDLAlgorithm::processElement(), DDLSpecPar::processElement(), DDLBox::processElement(), DDLCone::processElement(), DDLPolyGenerator::processElement(), DDLRotationAndReflection::processElement(), DDLDivision::processElement(), DDLElementaryMaterial::processElement(), DDLBooleanSolid::processElement(), DDLPosPart::processElement(), DDLNumeric::processElement(), DDLVector::processElement(), DDLCompositeMaterial::processElement(), DDLLogicalPart::processElement(), DDLMap::processElement(), DDLRotationByAxis::processOne(), DDLMaterial::setReference(), and DDLSolid::setReference().
|
private |
Definition at line 186 of file DDXMLElement.h.
Referenced by parent(), and setParent().
|
private |
Definition at line 181 of file DDXMLElement.h.
Referenced by appendText(), clear(), getText(), gotText(), and loadText().