CMS 3D CMS Logo

List of all members | Public Member Functions | Private Attributes
DDLRotationByAxis Class Reference

DDLRotationByAxis handles RotationByAxis elements. More...

#include <DDLRotationByAxis.h>

Inheritance diagram for DDLRotationByAxis:
DDXMLElement DDLRotationSequence

Public Member Functions

 DDLRotationByAxis (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...
 
virtual DDRotationMatrix processOne (DDRotationMatrix R, std::string &axis, std::string &angle)
 
- 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...
 
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 Attributes

std::string pName
 
std::string pNameSpace
 

Additional Inherited Members

- Protected Attributes inherited from DDXMLElement
DDLElementRegistrymyRegistry_
 

Detailed Description

DDLRotationByAxis handles RotationByAxis elements.

Author
Michael Case

DDLRotationByAxis.h - description

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

This is the RotationByAxis element which rotates around an axis.

Definition at line 25 of file DDLRotationByAxis.h.

Constructor & Destructor Documentation

◆ DDLRotationByAxis()

DDLRotationByAxis::DDLRotationByAxis ( DDLElementRegistry myreg)

Definition at line 18 of file DDLRotationByAxis.cc.

18 : DDXMLElement(myreg) {}

Member Function Documentation

◆ preProcessElement()

void DDLRotationByAxis::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.

Reimplemented in DDLRotationSequence.

Definition at line 20 of file DDLRotationByAxis.cc.

20  {
21  pNameSpace = nmspace;
22  pName = name;
23 }

References Skims_PA_cff::name, pName, and pNameSpace.

◆ processElement()

void DDLRotationByAxis::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.

Reimplemented in DDLRotationSequence.

Definition at line 25 of file DDLRotationByAxis.cc.

25  {
27  if (parent() != "RotationSequence") {
28  std::string axis = atts.find("axis")->second;
29  std::string angle = atts.find("angle")->second;
30 
32  R = processOne(R, axis, angle);
33 
34  if (atts.find("name") == atts.end()) {
35  auto myRealParent = myRegistry_->getElement(parent());
36  DDName pName = myRealParent->getDDName(nmspace);
37  std::string tn = pName.name() + std::string("Rotation");
38  std::vector<std::string> names;
39  names.emplace_back("name");
40 
41  std::vector<std::string> values;
42  values.emplace_back(tn);
43 
44  clear();
45  loadAttributes(name, names, values, nmspace, cpv);
46  }
47  DDRotation rot = DDrot(getDDName(nmspace), std::make_unique<DDRotationMatrix>(R));
48 
49  clear();
50  }
51 }

References angle(), DDXMLElement::clear(), DDrot(), DDXMLElement::getAttributeSet(), DDXMLElement::getDDName(), DDLElementRegistry::getElement(), DDXMLElement::loadAttributes(), DDXMLElement::myRegistry_, Skims_PA_cff::name, names, DDXMLElement::parent(), pName, processOne(), dttmaxenums::R, makeMuonMisalignmentScenario::rot, AlCaHLTBitMon_QueryRunRegistry::string, and contentValuesCheck::values.

◆ processOne()

DDRotationMatrix DDLRotationByAxis::processOne ( DDRotationMatrix  R,
std::string &  axis,
std::string &  angle 
)
virtual

Get the name, axis and angle of the RotationByAxis and do it.

Definition at line 53 of file DDLRotationByAxis.cc.

53  {
58  double dAngle = ev.eval(pNameSpace, angle);
59 
60  if (axis == "x") {
61  R = ROOT::Math::RotationX(dAngle);
62  } else if (axis == "y") {
63  R = ROOT::Math::RotationY(dAngle);
64  } else if (axis == "z") {
65  R = ROOT::Math::RotationZ(dAngle);
66  } else {
67  std::string msg = "\nDDLRotationByAxis invalid axis... you must not have validated XML sources! Element is ";
68  msg += pName;
69  throwError(msg);
70  }
71 
72  return R;
73 }

References angle(), ev, DDLElementRegistry::evaluator(), mps_check::msg, DDXMLElement::myRegistry_, pName, pNameSpace, dttmaxenums::R, AlCaHLTBitMon_QueryRunRegistry::string, and DDXMLElement::throwError().

Referenced by processElement().

Member Data Documentation

◆ pName

std::string DDLRotationByAxis::pName
private

Definition at line 36 of file DDLRotationByAxis.h.

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

◆ pNameSpace

std::string DDLRotationByAxis::pNameSpace
private

Definition at line 35 of file DDLRotationByAxis.h.

Referenced by preProcessElement(), and processOne().

DDXMLElement::parent
const std::string & parent(void) const
access to parent element name
Definition: DDXMLElement.cc:201
DDXMLElement::clear
virtual void clear(void)
clear this element's contents.
Definition: DDXMLElement.cc:40
DDLRotationByAxis::pName
std::string pName
Definition: DDLRotationByAxis.h:36
DDrot
DDRotation DDrot(const DDName &name, std::unique_ptr< DDRotationMatrix > rot)
Definition of a uniquely identifiable rotation matrix named by DDName name.
Definition: DDRotation.cc:67
DDXMLElement::throwError
void throwError(const std::string &keyMessage) const
format std::string for throw an error.
Definition: DDXMLElement.cc:209
DDName
DDName is used to identify DDD entities uniquely.
Definition: DDName.h:17
DDLRotationByAxis::pNameSpace
std::string pNameSpace
Definition: DDLRotationByAxis.h:35
ClhepEvaluator
Definition: ClhepEvaluator.h:8
mps_check.msg
tuple msg
Definition: mps_check.py:285
DDXMLElement::loadAttributes
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.
Definition: DDXMLElement.cc:23
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
names
const std::string names[nVars_]
Definition: PhotonIDValueMapProducer.cc:124
contentValuesCheck.values
values
Definition: contentValuesCheck.py:38
DDXMLElement::DDXMLElement
DDXMLElement(DDLElementRegistry *myreg)
Constructor.
Definition: DDXMLElement.cc:14
DDLRotationByAxis::processOne
virtual DDRotationMatrix processOne(DDRotationMatrix R, std::string &axis, std::string &angle)
Definition: DDLRotationByAxis.cc:53
DDXMLAttribute
std::map< std::string, std::string > DDXMLAttribute
Definition: DDXMLElement.h:45
AlCaHLTBitMon_QueryRunRegistry.string
string string
Definition: AlCaHLTBitMon_QueryRunRegistry.py:256
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
DDRotationMatrix
ROOT::Math::Rotation3D DDRotationMatrix
A DDRotationMatrix is currently implemented with a ROOT Rotation3D.
Definition: DDRotationMatrix.h:8
ev
bool ev
Definition: Hydjet2Hadronizer.cc:97
makeMuonMisalignmentScenario.rot
rot
Definition: makeMuonMisalignmentScenario.py:322
angle
T angle(T x1, T y1, T z1, T x2, T y2, T z2)
Definition: angle.h:11
Skims_PA_cff.name
name
Definition: Skims_PA_cff.py:17
DDRotation
Represents a uniquely identifyable rotation matrix.
Definition: DDTransform.h:57
DDXMLElement::myRegistry_
DDLElementRegistry * myRegistry_
Definition: DDXMLElement.h:173
dttmaxenums::R
Definition: DTTMax.h:29