CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Private Member Functions | Private Attributes | Friends
DDLMap Class Referencefinal

DDLMap handles Map container. More...

#include <DDLMap.h>

Inheritance diagram for DDLMap:
DDXMLElement

Public Member Functions

 DDLMap (DDLElementRegistry *myreg)
 
ReadMapType< std::map
< std::string, double > > & 
getMapOfMaps (void)
 
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 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...
 
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

void do_makeDouble (char const *str, char const *end)
 
void do_makeName (char const *str, char const *end)
 
void do_pair (char const *str, char const *end)
 
void errorOut (const char *str)
 

Private Attributes

double pDouble
 
dd_map_type pMap
 
ReadMapType< std::map
< std::string, double > > 
pMapMap
 
std::string pName
 
std::string pNameSpace
 

Friends

class MapMakeDouble
 
class MapMakeName
 
class MapPair
 

Additional Inherited Members

- Protected Attributes inherited from DDXMLElement
DDLElementRegistrymyRegistry_
 

Detailed Description

DDLMap handles Map container.

Author
Michael Case

DDLMap.h - description

begin: Fri Nov 28, 2003 email: case@.nosp@m.ucdh.nosp@m.ep.uc.nosp@m.davi.nosp@m.s.edu

This is the Map container. It is a c++ stye std::map <std::string, double> and has a name associated with the Map for the DDD name-reference system.

Definition at line 33 of file DDLMap.h.

Constructor & Destructor Documentation

DDLMap::DDLMap ( DDLElementRegistry myreg)

Definition at line 63 of file DDLMap.cc.

63 : DDXMLElement(myreg) {}
DDXMLElement(DDLElementRegistry *myreg)
Constructor.
Definition: DDXMLElement.cc:14

Member Function Documentation

void DDLMap::do_makeDouble ( char const *  str,
char const *  end 
)
private

Definition at line 142 of file DDLMap.cc.

References ClhepEvaluator::eval(), DDLElementRegistry::evaluator(), DDXMLElement::myRegistry_, pDouble, pNameSpace, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by MapMakeDouble::operator()().

142  {
143  std::string ts(str, end);
145 }
DDLElementRegistry * myRegistry_
Definition: DDXMLElement.h:173
std::string pNameSpace
Definition: DDLMap.h:51
virtual std::vector< DDXMLAttribute >::const_iterator end(void)
ClhepEvaluator & evaluator()
double pDouble
Definition: DDLMap.h:49
double eval(const std::string &ns, const std::string &expr)
#define str(s)
void DDLMap::do_makeName ( char const *  str,
char const *  end 
)
private

Definition at line 140 of file DDLMap.cc.

References pName, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by MapMakeName::operator()().

140 { pName = std::string(str, end); }
std::string pName
Definition: DDLMap.h:50
virtual std::vector< DDXMLAttribute >::const_iterator end(void)
#define str(s)
void DDLMap::do_pair ( char const *  str,
char const *  end 
)
private

Definition at line 138 of file DDLMap.cc.

References pDouble, pMap, and pName.

Referenced by MapPair::operator()().

138 { pMap[pName] = pDouble; }
std::string pName
Definition: DDLMap.h:50
double pDouble
Definition: DDLMap.h:49
dd_map_type pMap
Definition: DDLMap.h:47
void DDLMap::errorOut ( const char *  str)
private

Definition at line 147 of file DDLMap.cc.

References mps_check::msg, AlCaHLTBitMon_QueryRunRegistry::string, and DDXMLElement::throwError().

Referenced by processElement().

147  {
148  std::string msg("\nDDLMap: Failed to parse the following: \n");
149  msg += std::string(str);
150  msg += "\n as a Map element (comma separated list of name=value).";
151  throwError(msg);
152 }
void throwError(const std::string &keyMessage) const
format std::string for throw an error.
tuple msg
Definition: mps_check.py:285
#define str(s)
ReadMapType< std::map< std::string, double > > & DDLMap::getMapOfMaps ( void  )

Definition at line 154 of file DDLMap.cc.

References pMapMap.

154 { return pMapMap; }
ReadMapType< std::map< std::string, double > > pMapMap
Definition: DDLMap.h:48
void DDLMap::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 88 of file DDLMap.cc.

References pDouble, pMap, pName, and pNameSpace.

88  {
89  pName = "";
90  pMap.clear();
91  //pMapMap.clear(); only the DDLAlgorithm is allowed to clear this guy!
92  pDouble = 0.0;
93  pNameSpace = nmspace;
94 }
std::string pNameSpace
Definition: DDLMap.h:51
std::string pName
Definition: DDLMap.h:50
double pDouble
Definition: DDLMap.h:49
dd_map_type pMap
Definition: DDLMap.h:47
void DDLMap::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 96 of file DDLMap.cc.

References DDXMLElement::clear(), errorOut(), ClhepEvaluator::eval(), DDLElementRegistry::evaluator(), DDXMLElement::getAttributeSet(), DDXMLElement::getDDName(), DDXMLElement::getText(), info(), visualization-live-secondInstance_cfg::m, DDXMLElement::myRegistry_, DDXMLElement::parent(), parse(), pMap, pMapMap, pNameSpace, and AlCaHLTBitMon_QueryRunRegistry::string.

96  {
97  std::string tTextToParse = getText();
99  std::string tName = atts.find("name")->second;
100 
101  if (tTextToParse.empty()) {
102  errorOut("No std::string to parse!");
103  }
104 
105  // NOT IMPLEMENTED YET
106  if (atts.find("type") != atts.end() && atts.find("type")->second == "string") {
107  errorOut("Map of type std::string is not supported yet.");
108  }
109 
110  Mapper mapGrammar{this};
111 
112  pMap.clear();
113 
114  parse_info<> info = boost::spirit::classic::parse(tTextToParse.c_str(), mapGrammar >> end_p, space_p);
115  if (!info.full) {
116  errorOut("Does not conform to name=value, name=value... etc. of ddl Map element.");
117  }
118 
119  if (parent() == "Algorithm" || parent() == "SpecPar") {
120  pMapMap[tName] = pMap;
121  } else if (parent() == "ConstantsSection" || parent() == "DDDefinition") {
122  dd_map_type tMap;
123  for (std::map<std::string, double>::const_iterator it = pMap.begin(); it != pMap.end(); ++it) {
124  tMap[it->first] = it->second;
125  }
126  DDMap m(getDDName(pNameSpace), std::make_unique<dd_map_type>(tMap));
127  // clear the map of maps, because in these elements we only have ONE at a time.
128  pMapMap.clear();
129  }
130 
131  std::string nEntries = atts.find("nEntries")->second;
132  if (pMap.size() != size_t(myRegistry_->evaluator().eval(pNameSpace, nEntries))) {
133  errorOut("Number of entries found in Map text does not match number in attribute nEntries.");
134  }
135  clear();
136 }
vector< string > parse(string line, const string &delimiter)
static const TGPicture * info(bool iBackgroundIsBlack)
DDLElementRegistry * myRegistry_
Definition: DDXMLElement.h:173
virtual const DDXMLAttribute & getAttributeSet(size_t aIndex=0) const
Get a &quot;row&quot; of attributes, i.e. one attribute set.
Definition: DDXMLElement.cc:54
std::string pNameSpace
Definition: DDLMap.h:51
const std::string & parent(void) const
access to parent element name
a named constant corresponding to the DDL-XML tag &lt;Constant&gt; and &lt;ConstantsVector&gt; ...
Definition: DDMap.h:22
std::map< std::string, std::string > DDXMLAttribute
Definition: DDXMLElement.h:45
ClhepEvaluator & evaluator()
Definition: DDLMap.cc:41
ReadMapType< std::map< std::string, double > > pMapMap
Definition: DDLMap.h:48
void errorOut(const char *str)
Definition: DDLMap.cc:147
double eval(const std::string &ns, const std::string &expr)
virtual void clear(void)
clear this element&#39;s contents.
Definition: DDXMLElement.cc:40
virtual const DDName getDDName(const std::string &defaultNS, const std::string &attname=std::string("name"), size_t aIndex=0)
Definition: DDXMLElement.cc:56
dd_map_type pMap
Definition: DDLMap.h:47
const std::string getText(size_t tindex=0) const
retrieve the text blob.

Friends And Related Function Documentation

friend class MapMakeDouble
friend

Definition at line 36 of file DDLMap.h.

friend class MapMakeName
friend

Definition at line 35 of file DDLMap.h.

friend class MapPair
friend

Definition at line 34 of file DDLMap.h.

Member Data Documentation

double DDLMap::pDouble
private

Definition at line 49 of file DDLMap.h.

Referenced by do_makeDouble(), do_pair(), and preProcessElement().

dd_map_type DDLMap::pMap
private

Definition at line 47 of file DDLMap.h.

Referenced by do_pair(), preProcessElement(), and processElement().

ReadMapType<std::map<std::string, double> > DDLMap::pMapMap
private

Definition at line 48 of file DDLMap.h.

Referenced by getMapOfMaps(), and processElement().

std::string DDLMap::pName
private

Definition at line 50 of file DDLMap.h.

Referenced by do_makeName(), do_pair(), and preProcessElement().

std::string DDLMap::pNameSpace
private

Definition at line 51 of file DDLMap.h.

Referenced by do_makeDouble(), preProcessElement(), and processElement().