CMS 3D CMS Logo

List of all members | Public Member Functions | Private Member Functions | Friends
DDRotation Class Reference

Represents a uniquely identifyable rotation matrix. More...

#include <DDTransform.h>

Inheritance diagram for DDRotation:
DDBase< DDName, std::unique_ptr< DDRotationMatrix > >

Public Member Functions

 DDRotation ()
 refers to the unit-rotation (no rotation at all) More...
 
 DDRotation (const DDName &name)
 Creates a initialized reference-object or a reference to an allready defined rotation. More...
 
 DDRotation (const DDName &, std::unique_ptr< DDRotationMatrix >)
 
DDRotationMatrixmatrix ()
 
const DDRotationMatrixrotation () const
 Returns the read-only rotation-matrix. More...
 
DDRotationMatrixrotation ()
 
- Public Member Functions inherited from DDBase< DDName, std::unique_ptr< DDRotationMatrix > >
void create (const DDName &name, std::unique_ptr< DDRotationMatrix > vals)
 
void create (const DDName &name)
 
 DDBase ()
 
const DDNameddname () const
 
def_type isDefined () const
 
bool isValid () const
 true, if the wrapped pointer is valid More...
 
const DDNamename () const
 
 operator bool () const
 
bool operator< (const DDBase &b) const
 
bool operator== (const DDBase &b) const
 
bool operator> (const DDBase &b) const
 
const DDI::rep_traits< DDName, std::unique_ptr< DDRotationMatrix > >::reference rep () const
 
DDI::rep_traits< DDName, std::unique_ptr< DDRotationMatrix > >::reference rep ()
 
std::string toString () const
 
const DDI::rep_traits< DDName, std::unique_ptr< DDRotationMatrix > >::reference val () const
 
const DDI::rep_traits< DDName, std::unique_ptr< DDRotationMatrix > >::reference val ()
 
virtual ~DDBase ()
 

Private Member Functions

 DDRotation (std::unique_ptr< DDRotationMatrix >)
 

Friends

DDRotation DDanonymousRot (std::unique_ptr< DDRotationMatrix >)
 Defines a anonymous rotation or rotation-reflection matrix. More...
 
DDRotation DDrot (const DDName &, std::unique_ptr< DDRotationMatrix >)
 Definition of a uniquely identifiable rotation matrix named by DDName name. More...
 
std::unique_ptr< DDRotationDDrotPtr (const DDName &, std::unique_ptr< DDRotationMatrix >)
 
DDRotation DDrotReflect (const DDName &, double, double, double, double, double, double)
 Defines a rotation-reflection in the Geant3 way. More...
 

Additional Inherited Members

- Public Types inherited from DDBase< DDName, std::unique_ptr< DDRotationMatrix > >
using def_type = std::pair< const DDName *, bool >
 
using StoreT = DDI::Singleton< DDI::Store< DDName, std::unique_ptr< DDRotationMatrix > > >
 
- Static Public Member Functions inherited from DDBase< DDName, std::unique_ptr< DDRotationMatrix > >
static auto begin ()
 
static auto end ()
 

Detailed Description

Represents a uniquely identifyable rotation matrix.

An object of this class is a reference-object and thus leightweighted. It is uniquely identified by its DDName. Further details concerning reference-objects can be found in the documentation of DDLogicalPart.

DDRotation encapsulates ROOT Rotation3D.

Definition at line 57 of file DDTransform.h.

Constructor & Destructor Documentation

◆ DDRotation() [1/4]

DDRotation::DDRotation ( )

refers to the unit-rotation (no rotation at all)

Definition at line 40 of file DDRotation.cc.

References visDQMUpload::buf, ALPAKA_ACCELERATOR_NAMESPACE::brokenline::constexpr(), and DDBase< DDName, std::unique_ptr< DDRotationMatrix > >::create().

41  constexpr char const* baseName = "DdBlNa";
42  // In this particular case, we do not really care about multiple threads
43  // using the same counter, we simply need to have a unique id for the
44  // blank matrix being created, so just making this static an atomic should do
45  // the trick. In order to ensure repeatibility one should also include some
46  // some run specific Id, I guess. Not sure it really matters.
47  static std::atomic<int> countBlank;
48  char buf[64];
49  snprintf(buf, 64, "%s%i", baseName, countBlank++);
50  create(DDName(buf, baseName), std::make_unique<DDRotationMatrix>());
51 }
Definition: DDBase.h:10
DDName is used to identify DDD entities uniquely.
Definition: DDName.h:17
void create(const DDName &name, std::unique_ptr< DDRotationMatrix > vals)
Definition: DDBase.h:96

◆ DDRotation() [2/4]

DDRotation::DDRotation ( const DDName name)

Creates a initialized reference-object or a reference to an allready defined rotation.

A reference-object to a defined rotation is created if a rotation was already defined usind DDrot(). Otherwise a (default) initialized reference-object named name is created. At any later stage the rotation matrix can be defined using DDrot(). All initialized-reference object referring to the same name will then immidialtely refere to the matrix created by DDrot().

DDRotation is a lightweighted reference-object. For further details concerning reference-object refere to the documentation of DDLogicalPart.

Definition at line 53 of file DDRotation.cc.

References DDBase< DDName, std::unique_ptr< DDRotationMatrix > >::create(), and DDBase< DDName, std::unique_ptr< DDRotationMatrix > >::name().

Definition: DDBase.h:10
void create(const DDName &name, std::unique_ptr< DDRotationMatrix > vals)
Definition: DDBase.h:96

◆ DDRotation() [3/4]

DDRotation::DDRotation ( const DDName name,
std::unique_ptr< DDRotationMatrix rot 
)

◆ DDRotation() [4/4]

DDRotation::DDRotation ( std::unique_ptr< DDRotationMatrix rot)
private

Definition at line 60 of file DDRotation.cc.

References visDQMUpload::buf, DDBase< DDName, std::unique_ptr< DDRotationMatrix > >::create(), eostools::move(), and makeMuonMisalignmentScenario::rot.

61  static std::atomic<int> countNN;
62  char buf[64];
63  snprintf(buf, 64, "DdNoNa%i", countNN++);
64  create(DDName(buf, "DdNoNa"), std::move(rot));
65 }
Definition: DDBase.h:10
DDName is used to identify DDD entities uniquely.
Definition: DDName.h:17
def move(src, dest)
Definition: eostools.py:511
void create(const DDName &name, std::unique_ptr< DDRotationMatrix > vals)
Definition: DDBase.h:96

Member Function Documentation

◆ matrix()

DDRotationMatrix& DDRotation::matrix ( void  )
inline

Definition at line 85 of file DDTransform.h.

References rotation().

Referenced by TGeoMgrFromDdd::createShape(), DDHtmlRoDetails::details(), DDTrackerIrregularRingAlgo::execute(), and DDTrackerRingAlgo::execute().

85 { return rotation(); }
const DDRotationMatrix & rotation() const
Returns the read-only rotation-matrix.
Definition: DDTransform.h:81

◆ rotation() [1/2]

const DDRotationMatrix& DDRotation::rotation ( void  ) const
inline

Returns the read-only rotation-matrix.

Definition at line 81 of file DDTransform.h.

References DDBase< DDName, std::unique_ptr< DDRotationMatrix > >::rep().

Referenced by DDCompareDDRot(), DDPixFwdBladesNew::execute(), DDPixFwdBlades::execute(), matrix(), DDCoreToDDXMLOutput::position(), DDPosData::rot(), and DDPosData::rotation().

81 { return rep(); }
const DDI::rep_traits< DDName, std::unique_ptr< DDRotationMatrix > >::reference rep() const
Definition: DDBase.h:65

◆ rotation() [2/2]

DDRotationMatrix& DDRotation::rotation ( void  )
inline

Definition at line 83 of file DDTransform.h.

References DDBase< DDName, std::unique_ptr< DDRotationMatrix > >::rep().

83 { return rep(); }
const DDI::rep_traits< DDName, std::unique_ptr< DDRotationMatrix > >::reference rep() const
Definition: DDBase.h:65

Friends And Related Function Documentation

◆ DDanonymousRot

DDRotation DDanonymousRot ( std::unique_ptr< DDRotationMatrix rot)
friend

Defines a anonymous rotation or rotation-reflection matrix.

It can't be addressed by a unique DDName. Once created, it's the users responsibility to keep the reference object DDRotation! Will be mostly used by algorithmic positioning.

Definition at line 143 of file DDRotation.cc.

143 { return DDRotation(std::move(rot)); }
DDRotation()
refers to the unit-rotation (no rotation at all)
Definition: DDRotation.cc:40
def move(src, dest)
Definition: eostools.py:511

◆ DDrot

DDRotation DDrot ( const DDName name,
std::unique_ptr< DDRotationMatrix rot 
)
friend

Definition of a uniquely identifiable rotation matrix named by DDName name.

DDrot() returns a reference-object DDRotation representing the rotation matrix rot.

The user must not free memory allocated for rot!

Definition at line 67 of file DDRotation.cc.

67  {
68  // memory of rot goes sto DDRotationImpl!!
69  return DDRotation(ddname, std::move(rot));
70 }
DDRotation()
refers to the unit-rotation (no rotation at all)
Definition: DDRotation.cc:40
def move(src, dest)
Definition: eostools.py:511

◆ DDrotPtr

std::unique_ptr<DDRotation> DDrotPtr ( const DDName name,
std::unique_ptr< DDRotationMatrix rot 
)
friend

Definition at line 72 of file DDRotation.cc.

72  {
73  // memory of rot goes sto DDRotationImpl!!
74  return std::make_unique<DDRotation>(ddname, std::move(rot));
75 }
def move(src, dest)
Definition: eostools.py:511

◆ DDrotReflect

DDRotation DDrotReflect ( const DDName name,
double  thetaX,
double  phiX,
double  thetaY,
double  phiY,
double  thetaZ,
double  phiZ 
)
friend

Defines a rotation-reflection in the Geant3 way.

The resulting matrix MUST be a LEFThanded orthonormal system, otherwise a DDException will be thrown!

Definition at line 101 of file DDRotation.cc.

102  {
103  // define 3 unit std::vectors forming the new left-handed axes
104  DD3Vector x(cos(phiX) * sin(thetaX), sin(phiX) * sin(thetaX), cos(thetaX));
105  DD3Vector y(cos(phiY) * sin(thetaY), sin(phiY) * sin(thetaY), cos(thetaY));
106  DD3Vector z(cos(phiZ) * sin(thetaZ), sin(phiZ) * sin(thetaZ), cos(thetaZ));
107 
108  double tol = 1.0e-3; // Geant4 compatible
109  double check = (x.Cross(y)).Dot(z); // in case of a LEFT-handed orthogonal system this must be -1
110  if (fabs(1. + check) > tol) {
111  edm::LogError("DDRotation") << ddname << " is not a LEFT-handed orthonormal matrix!" << std::endl;
112  throw cms::Exception("DDException") << ddname.name() << " is not LEFT-handed!";
113  }
114 
115  return DDRotation(ddname,
116  std::make_unique<DDRotationMatrix>(x.x(), y.x(), z.x(), x.y(), y.y(), z.y(), x.z(), y.z(), z.z()));
117 }
Sin< T >::type sin(const T &t)
Definition: Sin.h:22
Log< level::Error, false > LogError
ROOT::Math::DisplacementVector3D< ROOT::Math::Cartesian3D< double > > DD3Vector
const std::string & name() const
Returns the name.
Definition: DDName.cc:41
Cos< T >::type cos(const T &t)
Definition: Cos.h:22
DDRotation()
refers to the unit-rotation (no rotation at all)
Definition: DDRotation.cc:40