CMS 3D CMS Logo

List of all members | Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends
DDXMLElement Class Reference

This is a base class for processing XML elements in the DDD. More...

#include <DDXMLElement.h>

Inheritance diagram for DDXMLElement:
DDLAlgorithm DDLDivision DDLLogicalPart DDLMap DDLMaterial DDLNumeric DDLPosPart DDLRotationAndReflection DDLRotationByAxis DDLSolid DDLSpecPar DDLString DDLVector

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 DDXMLAttributegetAttributeSet (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

DDLElementRegistrymyRegistry_
 

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< DDXMLAttributeattributes_
 
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)
 

Detailed Description

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.

Constructor & Destructor Documentation

DDXMLElement::DDXMLElement ( DDLElementRegistry myreg)

Constructor.

Definition at line 15 of file DDXMLElement.cc.

16  : myRegistry_( myreg ),
17  attributes_(),
18  text_(),
19  autoClear_( false )
20 {}
DDLElementRegistry * myRegistry_
Definition: DDXMLElement.h:172
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
std::vector< std::string > text_
Definition: DDXMLElement.h:179
DDXMLElement::DDXMLElement ( DDLElementRegistry myreg,
const bool &  clearme 
)

Constructor for autoClear element.

Definition at line 22 of file DDXMLElement.cc.

23  : myRegistry_( myreg ),
24  attributes_(),
25  text_(),
26  autoClear_( clearme )
27 {}
DDLElementRegistry * myRegistry_
Definition: DDXMLElement.h:172
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
std::vector< std::string > text_
Definition: DDXMLElement.h:179
virtual DDXMLElement::~DDXMLElement ( void  )
virtualdefault

Destructor.

Member Function Documentation

void DDXMLElement::appendAttributes ( std::vector< std::string > &  tv,
const std::string &  name 
)
private

behind the scenes appending to pAttributes...

Definition at line 233 of file DDXMLElement.cc.

References attributes_, end(), and mps_fire::i.

Referenced by getVectorAttribute().

235 {
236  for (size_t i = tv.size(); i < attributes_.size(); ++i)
237  {
238  DDXMLAttribute::const_iterator itnv = attributes_[i].find(name);
239  if (itnv != attributes_[i].end())
240  tv.push_back(itnv->second);
241  else
242  tv.push_back("");
243  }
244 }
virtual std::vector< DDXMLAttribute >::const_iterator end(void)
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
void DDXMLElement::appendText ( const std::string &  inText)

append to the current (i.e. most recently added)

Definition at line 181 of file DDXMLElement.cc.

References mps_alisetup::msg, AlCaHLTBitMon_QueryRunRegistry::string, text_, and throwError().

182 {
183  static const std::string cr("\n");
184  if (text_.size() > 0) {
185  text_[text_.size() - 1] += cr;
186  text_[text_.size() - 1] += inText ;
187  } else
188  {
189  std::string msg = "DDXMLElement::appendText could not append to non-existent text.";
190  throwError(msg);
191  }
192 }
void throwError(const std::string &keyMessage) const
format std::string for throw an error.
std::vector< std::string > text_
Definition: DDXMLElement.h:179
std::vector< DDXMLAttribute >::const_iterator DDXMLElement::begin ( void  )
virtual

Definition at line 254 of file DDXMLElement.cc.

References attributes_, and myIter_.

255 {
256  myIter_ = attributes_.begin();
257  return attributes_.begin();
258 }
std::vector< DDXMLAttribute >::const_iterator myIter_
Definition: DDXMLElement.h:182
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
void DDXMLElement::clear ( void  )
virtual

clear this element's contents.

Definition at line 55 of file DDXMLElement.cc.

References attributeAccumulator_, attributes_, AlCaHLTBitMon_QueryRunRegistry::string, and text_.

Referenced by DDLVector::clearall(), Vispa.Views.WidgetView.WidgetView::closeEvent(), Vispa.Views.BoxDecayView.BoxDecayView::closeEvent(), Vispa.Share.FindAlgorithm.FindAlgorithm::findUsingFindDialog(), DDLMultiUnionSolid::processElement(), DDLPgonGenerator::processElement(), DDLRotationSequence::processElement(), DDLSpecPar::processElement(), DDLAlgorithm::processElement(), DDLRotationByAxis::processElement(), DDLString::processElement(), DDLBooleanSolid::processElement(), DDLDivision::processElement(), DDLElementaryMaterial::processElement(), DDLPosPart::processElement(), DDLPolyGenerator::processElement(), DDLRotationAndReflection::processElement(), DDLNumeric::processElement(), DDLCompositeMaterial::processElement(), DDLLogicalPart::processElement(), DDLVector::processElement(), DDLMap::processElement(), processElement(), Vispa.Views.LineDecayView.LineDecayView::setDataObjects(), Vispa.Views.WidgetView.WidgetView::setDataObjects(), DDLMaterial::setReference(), DDLSolid::setReference(), BeautifulSoup.Tag::setString(), Vispa.Views.TreeView.TreeView::updateContent(), Vispa.Views.TableView.TableView::updateContent(), Vispa.Views.BoxDecayView.BoxDecayView::updateContent(), and Vispa.Views.PropertyView.PropertyView::updateContent().

56 {
57  text_.clear();
58  attributes_.clear();
59  attributeAccumulator_.clear();
60 }
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
AttrAccumType attributeAccumulator_
Definition: DDXMLElement.h:180
std::vector< std::string > text_
Definition: DDXMLElement.h:179
std::vector< DDXMLAttribute >::const_iterator DDXMLElement::end ( void  )
virtual

Definition at line 261 of file DDXMLElement.cc.

References attributes_, and myIter_.

Referenced by appendAttributes(), Types.LuminosityBlockRange::cppID(), Types.EventRange::cppID(), and get().

262 {
263  myIter_ = attributes_.end();
264  return attributes_.end();
265 }
std::vector< DDXMLAttribute >::const_iterator myIter_
Definition: DDXMLElement.h:182
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
const std::string & DDXMLElement::get ( const std::string &  name,
size_t  aIndex = 0 
) const
virtual

Returns a specific value from the aIndex set of attributes.

Definition at line 113 of file DDXMLElement.cc.

References attributes_, end(), mps_alisetup::msg, dataset::name, AlCaHLTBitMon_QueryRunRegistry::string, and throwError().

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), util.rrapi.RRApi::columns(), rrapi.RRApi::columns(), util.rrapi.RRApi::count(), rrapi.RRApi::count(), rrapi.RRApi::data(), util.rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), util.rrapi.RRApi::report(), rrapi.RRApi::reports(), util.rrapi.RRApi::reports(), util.rrapi.RRApi::tables(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), util.rrapi.RRApi::tags(), rrapi.RRApi::templates(), util.rrapi.RRApi::templates(), util.rrapi.RRApi::workspaces(), and rrapi.RRApi::workspaces().

114 {
115  static const std::string sts;
116  if (aIndex < attributes_.size())
117  {
118  DDXMLAttribute::const_iterator it = attributes_[aIndex].find(name);
119  if (attributes_[aIndex].end() == it)
120  {
121  return sts;
122  }
123  else
124  return (it->second);
125  }
126  std::string msg = "DDXMLElement:get failed. It was asked for attribute " + name;
127  msg += " in position " + std::to_string(aIndex) + " when there are only ";
128  msg += std::to_string(attributes_.size()) + " in the element storage.\n";
129  throwError(msg);
130  // meaningless...
131  return sts;
132 }
void throwError(const std::string &keyMessage) const
format std::string for throw an error.
virtual std::vector< DDXMLAttribute >::const_iterator end(void)
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
const std::string & DDXMLElement::getAttribute ( const std::string &  name) const
virtual

Access to attributes by name.

Definition at line 64 of file DDXMLElement.cc.

References attributes_, and AlCaHLTBitMon_QueryRunRegistry::string.

65 {
66  static const std::string ldef;
67  if (attributes_.size())
68  return get(name, attributes_.size() - 1);
69  return ldef;
70 }
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
const DDXMLAttribute & DDXMLElement::getAttributeSet ( size_t  aIndex = 0) const
virtual
const DDName DDXMLElement::getDDName ( const std::string &  defaultNS,
const std::string &  attname = std::string( "name" ),
size_t  aIndex = 0 
)
virtual

Definition at line 80 of file DDXMLElement.cc.

References attributes_, mps_alisetup::msg, dataset::name, AlCaHLTBitMon_QueryRunRegistry::string, and throwError().

Referenced by DDLRotationAndReflection::isLeftHanded(), DDLMultiUnionSolid::processElement(), DDLPgonGenerator::processElement(), DDLTubs::processElement(), DDLPseudoTrap::processElement(), DDLTrapezoid::processElement(), DDLOrb::processElement(), DDLTorus::processElement(), DDLParallelepiped::processElement(), DDLEllipsoid::processElement(), DDLEllipticalTube::processElement(), DDLReflectionSolid::processElement(), DDLShapelessSolid::processElement(), DDLSphere::processElement(), DDLRotationSequence::processElement(), DDLAlgorithm::processElement(), DDLRotationByAxis::processElement(), DDLSpecPar::processElement(), DDLCone::processElement(), DDLBox::processElement(), DDLString::processElement(), DDLRotationAndReflection::processElement(), DDLPolyGenerator::processElement(), DDLBooleanSolid::processElement(), DDLElementaryMaterial::processElement(), DDLDivision::processElement(), DDLNumeric::processElement(), DDLCompositeMaterial::processElement(), DDLLogicalPart::processElement(), DDLVector::processElement(), and DDLMap::processElement().

81 {
82  if (aIndex < attributes_.size()
83  && attributes_[aIndex].find(attname) != attributes_[aIndex].end()) {
84  std::string ns = defaultNS;
85  // For the user to fully control namespaces they must provide for
86  // all name attributes something of the form, for example:
87  // <Solid name="ns:name" ...
88  // If defaultNS is "!" (magic I don't like) then find and set
89  // the namespace properly.
90  if ( defaultNS == "!" ) {
91  ns = "";
92  }
93  const std::string & name = attributes_[aIndex].find(attname)->second;
94  std::string rn = name;
95  size_t foundColon= name.find(':');
96  if (foundColon != std::string::npos) {
97  ns = name.substr(0,foundColon);
98  rn = name.substr(foundColon+1);
99 
100  }
101  return DDName(rn, ns);
102  }
103  std::string msg = "DDXMLElement:getDDName failed. It was asked to make ";
104  msg += "a DDName using attribute: " + attname;
105  msg += " in position: " + std::to_string(aIndex) + ". There are ";
106  msg += std::to_string(attributes_.size()) + " entries in the element.";
107  throwError(msg);
108  return DDName("justToCompile", "justToCompile"); // used to make sure it compiles
109 }
void throwError(const std::string &keyMessage) const
format std::string for throw an error.
DDName is used to identify DDD entities uniquely.
Definition: DDName.h:15
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
const std::string DDXMLElement::getText ( size_t  tindex = 0) const

retrieve the text blob.

Definition at line 195 of file DDXMLElement.cc.

References mps_alisetup::msg, AlCaHLTBitMon_QueryRunRegistry::string, text_, and throwError().

Referenced by DDLVector::processElement(), and DDLMap::processElement().

196 {
197  if (tindex > text_.size()) {
198  std::string msg = "DDXMLElement::getText tindex is greater than text_.size()).";
199  throwError(msg);
200  }
201  return text_[tindex];
202 }
void throwError(const std::string &keyMessage) const
format std::string for throw an error.
std::vector< std::string > text_
Definition: DDXMLElement.h:179
std::vector< std::string > DDXMLElement::getVectorAttribute ( const std::string &  name)
virtual

Returns a set of values as a std::vector of strings, given the attribute name.

Definition at line 137 of file DDXMLElement.cc.

References appendAttributes(), attributeAccumulator_, attributes_, and dataset::name.

138 {
139  // The idea here is that the attributeAccumulator_ is a cache of
140  // on-the-fly generation from the std::vector<DDXMLAttribute> and the
141  // reason is simply to speed things up if it is requested more than once.
142  std::vector<std::string> tv;
143  AttrAccumType::const_iterator ita = attributeAccumulator_.find(name);
144  if (ita != attributeAccumulator_.end())
145  {
147  if (tv.size() < attributes_.size())
148  {
149  appendAttributes(tv, name);
150  }
151  }
152  else
153  {
154  if (attributes_.size())
155  {
156  appendAttributes(tv, name);
157  }
158  else
159  {
160  // throw cms::Exception("DDException") << msg;
161  }
162  }
163  return tv;
164 }
void appendAttributes(std::vector< std::string > &tv, const std::string &name)
behind the scenes appending to pAttributes...
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
AttrAccumType attributeAccumulator_
Definition: DDXMLElement.h:180
bool DDXMLElement::gotText ( void  ) const
virtual

gotText()? kind of like gotMilk? Yes = text has already been encountered.

Definition at line 205 of file DDXMLElement.cc.

References text_.

206 {
207  if (text_.size() != 0)
208  return true;
209  return false;
210 }
std::vector< std::string > text_
Definition: DDXMLElement.h:179
bool DDXMLElement::isEmpty ( void  ) const
virtual

Have any elements of this type been encountered but not processed?

Definition at line 293 of file DDXMLElement.cc.

References attributes_.

Referenced by plotting.Plot::clone().

294 {
295  return (attributes_.size() == 0 ? true : false);
296 }
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
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 36 of file DDXMLElement.cc.

References attributes_, mps_fire::i, and preProcessElement().

Referenced by DDLRotationByAxis::processElement().

40 {
41  attributes_.resize(attributes_.size()+1);
42  DDXMLAttribute & tAttributes = attributes_.back();
43 
44  // adds attributes
45  for (size_t i = 0; i < names.size(); ++i)
46  {
47  tAttributes.insert(std::make_pair(names[i], values[i]));
48  }
49 
50  preProcessElement( elemName, nmspace, cpv );
51 }
static const HistoName names[]
std::map< std::string, std::string > DDXMLAttribute
Definition: DDXMLElement.h:45
virtual void preProcessElement(const std::string &name, const std::string &nmspace, DDCompactView &cpv)
Called by loadAttributes AFTER attributes are loaded.
Definition: DDXMLElement.cc:31
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
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 175 of file DDXMLElement.cc.

References text_.

Referenced by processElement().

176 {
177  text_.push_back(inText);
178 }
std::vector< std::string > text_
Definition: DDXMLElement.h:179
std::vector< DDXMLAttribute >::const_iterator & DDXMLElement::operator++ ( int  inc)

Allow the elements of this type to be iterated over using ++ operator.

Definition at line 268 of file DDXMLElement.cc.

References myIter_, and AlCaHLTBitMon_QueryRunRegistry::string.

269 {
270  myIter_ = myIter_ + inc;
271  return myIter_;
272 }
std::vector< DDXMLAttribute >::const_iterator myIter_
Definition: DDXMLElement.h:182
const std::string & DDXMLElement::parent ( void  ) const

access to parent element name

Definition at line 275 of file DDXMLElement.cc.

References parentElement_.

Referenced by Vispa.Gui.ConnectableWidget.ConnectableWidget::addMenuEntry(), Vispa.Views.LineDecayView.LineDecayContainer::applyFilter(), Vispa.Views.BoxDecayView.BoxDecayContainer::arrangeUsingRelations(), Vispa.Views.BoxDecayView.BoxDecayContainer::autolayoutAlgorithm(), Vispa.Gui.ZoomableScrollableWidgetOwner.ZoomableScrollableWidgetOwner::autosizeScrollArea(), Vispa.Views.BoxDecayView.BoxDecayContainer::autosizeScrollArea(), Vispa.Gui.PortWidget.PortWidget::connectionPoint(), Vispa.Main.StartupScreen.StartupScreen::createDescriptionWidget(), Vispa.Views.BoxDecayView.BoxDecayContainer::dataAccessor(), Vispa.Views.LineDecayView.LineDecayContainer::dataAccessor(), Vispa.Views.LineDecayView.DecayLine::dataAccessor(), Vispa.Views.LineDecayView.LineDecayContainer::delete(), Vispa.Views.LineDecayView.DecayNode::delete(), Vispa.Views.LineDecayView.DecayLine::delete(), Vispa.Gui.VispaWidget.VispaWidget::delete(), Vispa.Gui.VispaWidget.VispaWidget::dragWidget(), Vispa.Share.ImageExporter.ImageExporter::exportImageDialog(), Vispa.Views.LineDecayView.DecayLine::extendedSize(), Vispa.Gui.VispaWidget.VispaWidget::keyPressEvent(), Vispa.Gui.MenuWidget.MenuWidget::leaveEvent(), Vispa.Gui.ConnectableWidget.ConnectableWidget::leaveEvent(), Vispa.Gui.PortWidget.PortWidget::moduleParent(), Vispa.Gui.WidgetContainer.WidgetContainer::mouseDoubleClickEvent(), Vispa.Gui.VispaWidget.VispaWidget::mouseDoubleClickEvent(), Vispa.Gui.PortConnection.PointToPointConnection::mousePressEvent(), Vispa.Gui.VispaWidget.VispaWidget::mousePressEvent(), Vispa.Views.LineDecayView.ParticleWidget::mousePressEvent(), Vispa.Views.LineDecayView.DecayNode::move(), Vispa.Views.LineDecayView.LineDecayContainer::noDecorationsMode(), Vispa.Views.LineDecayView.LineDecayContainer::operationId(), Vispa.Views.LineDecayView.DecayLine::paint(), Vispa.Gui.VispaWidget.VispaWidget::paintEvent(), Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget(), DDLRotationByAxis::processElement(), DDLString::processElement(), DDLDivision::processElement(), DDLNumeric::processElement(), DDLVector::processElement(), DDLMap::processElement(), Vispa.Views.LineDecayView.DecayLine::qtLineStyle(), Vispa.Views.WidgetView.WidgetView::restoreSelection(), Vispa.Views.WidgetView.WidgetView::select(), Vispa.Gui.PortConnection.PointToPointConnection::select(), Vispa.Gui.VispaWidget.VispaWidget::select(), Vispa.Views.LineDecayView.LineDecayContainer::select(), DDLSolid::setReference(), Vispa.Views.LineDecayView.LineDecayContainer::sizeHint(), Vispa.Views.LineDecayView.LineDecayContainer::tabController(), Vispa.Views.BoxDecayView.BoxDecayContainer::toggleCollapsed(), Vispa.Views.LineDecayView.DecayNode::unite(), Vispa.Views.PropertyView.PropertyView::valueChanged(), Vispa.Views.BoxDecayView.BoxDecayContainer::widgetByObject(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::widgetDoubleClicked(), and Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::widgetDragged().

276 {
277  return parentElement_;
278 }
std::string parentElement_
Definition: DDXMLElement.h:184
void DDXMLElement::preProcessElement ( const std::string &  name,
const std::string &  nmspace,
DDCompactView cpv 
)
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, DDLVector, DDLLogicalPart, DDLCompositeMaterial, DDLNumeric, DDLPolyGenerator, DDLBooleanSolid, DDLDivision, DDLPosPart, DDLString, DDLAlgorithm, DDLRotationByAxis, DDLShapelessSolid, DDLRotationSequence, DDLReflectionSolid, DDLPgonGenerator, and DDLMultiUnionSolid.

Definition at line 31 of file DDXMLElement.cc.

Referenced by loadAttributes().

32 {}
void DDXMLElement::processElement ( const std::string &  name,
const std::string &  nmspace,
DDCompactView cpv 
)
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, DDLVector, DDLLogicalPart, DDLCompositeMaterial, DDLNumeric, DDLBooleanSolid, DDLDivision, DDLElementaryMaterial, DDLPolyGenerator, DDLPosPart, DDLRotationAndReflection, DDLBox, DDLCone, DDLString, DDLAlgorithm, DDLRotationByAxis, DDLSpecPar, DDLRotationSequence, DDLEllipsoid, DDLEllipticalTube, DDLReflectionSolid, DDLShapelessSolid, DDLSphere, DDLOrb, DDLParallelepiped, DDLPseudoTrap, DDLTorus, DDLTrapezoid, DDLTubs, DDLMultiUnionSolid, and DDLPgonGenerator.

Definition at line 168 of file DDXMLElement.cc.

References autoClear_, clear(), loadText(), and AlCaHLTBitMon_QueryRunRegistry::string.

169 {
171  if ( autoClear_ ) clear();
172 }
void loadText(const std::string &inText)
Used to load both text and XML comments into this object.
virtual void clear(void)
clear this element&#39;s contents.
Definition: DDXMLElement.cc:55
void DDXMLElement::setParent ( const std::string &  pename)

Set parent element name to central list of names.

Definition at line 281 of file DDXMLElement.cc.

References parentElement_.

Referenced by lumiQTWidget.LumiCanvas::__init__().

282 {
283  parentElement_ = pename;
284 }
std::string parentElement_
Definition: DDXMLElement.h:184
void DDXMLElement::setSelf ( const std::string &  sename)

Set self element name to central list of names.

Definition at line 287 of file DDXMLElement.cc.

References myElement_.

288 {
289  myElement_ = sename;
290 }
std::string myElement_
Definition: DDXMLElement.h:183
size_t DDXMLElement::size ( void  ) const
virtual

Number of elements accumulated.

Definition at line 248 of file DDXMLElement.cc.

References attributes_.

Referenced by ntupleDataFormat._Collection::__iter__(), and ntupleDataFormat._Collection::__len__().

249 {
250  return attributes_.size();
251 }
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
void DDXMLElement::stream ( std::ostream &  os) const
virtual

Allow for the elements to have their own streaming method, but also provide a default.

Definition at line 219 of file DDXMLElement.cc.

References attributes_.

Referenced by operator<<().

220 {
221  os << "Output of current element attributes:" << std::endl;
222  for (std::vector<DDXMLAttribute>::const_iterator itv = attributes_.begin();
223  itv != attributes_.end(); ++itv)
224  {
225  for (DDXMLAttribute::const_iterator it = itv->begin();
226  it != itv->end(); ++it)
227  os << it->first << " = " << it->second << "\t";
228  os << std::endl;
229  }
230 }
std::vector< DDXMLAttribute > attributes_
Definition: DDXMLElement.h:178
void DDXMLElement::throwError ( const std::string &  keyMessage) const

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const DDXMLElement element 
)
friend

Definition at line 212 of file DDXMLElement.cc.

213 {
214  element.stream(os);
215  return os;
216 }
virtual void stream(std::ostream &os) const
Allow for the elements to have their own streaming method, but also provide a default.

Member Data Documentation

AttrAccumType DDXMLElement::attributeAccumulator_
private

Definition at line 180 of file DDXMLElement.h.

Referenced by clear(), and getVectorAttribute().

std::vector<DDXMLAttribute> DDXMLElement::attributes_
private
bool DDXMLElement::autoClear_
private

Definition at line 181 of file DDXMLElement.h.

Referenced by processElement().

std::string DDXMLElement::myElement_
private

Definition at line 183 of file DDXMLElement.h.

Referenced by setSelf(), and throwError().

std::vector<DDXMLAttribute>::const_iterator DDXMLElement::myIter_
private

Definition at line 182 of file DDXMLElement.h.

Referenced by begin(), end(), and operator++().

DDLElementRegistry* DDXMLElement::myRegistry_
protected

Definition at line 172 of file DDXMLElement.h.

Referenced by DDLVector::do_makeDouble(), DDLMap::do_makeDouble(), DDLBooleanSolid::dumpBooleanSolid(), DDLMultiUnionSolid::dumpMultiUnionSolid(), DDLRotationAndReflection::isLeftHanded(), DDLRotationAndReflection::makeX(), DDLRotationAndReflection::makeY(), DDLRotationAndReflection::makeZ(), DDLMultiUnionSolid::preProcessElement(), DDLPgonGenerator::preProcessElement(), DDLReflectionSolid::preProcessElement(), DDLRotationSequence::preProcessElement(), DDLAlgorithm::preProcessElement(), DDLShapelessSolid::preProcessElement(), DDLBooleanSolid::preProcessElement(), DDLPosPart::preProcessElement(), DDLPolyGenerator::preProcessElement(), DDLCompositeMaterial::preProcessElement(), DDLLogicalPart::preProcessElement(), DDLMultiUnionSolid::processElement(), DDLPgonGenerator::processElement(), DDLTubs::processElement(), DDLTrapezoid::processElement(), DDLOrb::processElement(), DDLTorus::processElement(), DDLParallelepiped::processElement(), DDLPseudoTrap::processElement(), DDLReflectionSolid::processElement(), DDLSphere::processElement(), DDLEllipsoid::processElement(), DDLEllipticalTube::processElement(), DDLRotationSequence::processElement(), DDLRotationByAxis::processElement(), DDLAlgorithm::processElement(), DDLSpecPar::processElement(), DDLCone::processElement(), DDLBox::processElement(), DDLRotationAndReflection::processElement(), DDLElementaryMaterial::processElement(), DDLDivision::processElement(), DDLBooleanSolid::processElement(), DDLPosPart::processElement(), DDLPolyGenerator::processElement(), DDLNumeric::processElement(), DDLCompositeMaterial::processElement(), DDLLogicalPart::processElement(), DDLVector::processElement(), DDLMap::processElement(), DDLRotationByAxis::processOne(), DDLMaterial::setReference(), and DDLSolid::setReference().

std::string DDXMLElement::parentElement_
private

Definition at line 184 of file DDXMLElement.h.

Referenced by parent(), and setParent().

std::vector<std::string> DDXMLElement::text_
private

Definition at line 179 of file DDXMLElement.h.

Referenced by appendText(), clear(), getText(), gotText(), and loadText().