DDRotation Class Reference

Represents a uniquely identifyable rotation matrix. More...

#include <DDTransform.h>

Inheritance diagram for DDRotation:

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 &, DDRotationMatrix *)
DDRotationMatrix *	matrix ()
const DDRotationMatrix *	rotation () const
	Returns the read-only rotation-matrix. More...
DDRotationMatrix *	rotation ()
Public Member Functions inherited from DDBase< DDName, DDRotationMatrix * >
	DDBase ()
const DDName &	ddname () const
def_type	isDefined () const
bool	isValid () const
	true, if the wrapped pointer is valid More...
const DDName &	name () 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, DDRotationMatrix * >::reference	rep () const
DDI::rep_traits< DDName, DDRotationMatrix * >::reference	rep ()
std::string	toString () const
const DDI::rep_traits< DDName, DDRotationMatrix * >::reference	val () const
const DDI::rep_traits< DDName, DDRotationMatrix * >::reference	val ()
virtual	~DDBase ()

Private Member Functions
	DDRotation (DDRotationMatrix *)

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

Additional Inherited Members
Public Types inherited from DDBase< DDName, DDRotationMatrix * >
typedef std::pair< const DDName *, bool >	def_type
typedef DDRotationMatrix *	pimpl_type
typedef DDI::rep_type< DDName, pimpl_type > *	prep_type
typedef DDI::Singleton< DDI::Store< DDName, DDRotationMatrix * > >	StoreT
Static Public Member Functions inherited from DDBase< DDName, DDRotationMatrix * >
static auto	begin ()
static void	clear ()
static auto	end ()
static size_t	size ()
Protected Attributes inherited from DDBase< DDName, DDRotationMatrix * >
prep_type	prep_

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 CLHEP CLHEP::HepRotation.

Definition at line 64 of file DDTransform.h.

Constructor & Destructor Documentation

DDRotation::DDRotation

(

)

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

Definition at line 44 of file DDRotation.cc.

References constexpr, DDI::Singleton< I >::instance(), and DDBase< DDName, DDRotationMatrix * >::prep_.

Referenced by DDanonymousRot(), DDrot(), DDrotReflect(), and matrix().

                       : DDBase<DDName,DDRotationMatrix*>()
{
  constexpr char const* baseName = "DdBlNa";
  // In this particular case, we do not really care about multiple threads
  // using the same counter, we simply need to have a unique id for the 
  // blank matrix being created, so just making this static an atomic should do
  // the trick. In order to ensure repeatibility one should also include some 
  // some run specific Id, I guess. Not sure it really matters.
  static std::atomic<int> countBlank;
  char buf[64];
  snprintf(buf, 64, "%s%i", baseName, countBlank++);
  prep_ = StoreT::instance().create(DDName(buf,baseName), new DDRotationMatrix );
  //  std::cout << "making a BLANK " << buf << " named rotation, " << prep_->second << std::endl;
}

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 60 of file DDRotation.cc.

References DDI::Singleton< I >::instance(), and DDBase< DDName, DDRotationMatrix * >::prep_.

                                          : DDBase<DDName,DDRotationMatrix*>()
{
   prep_ = StoreT::instance().create(name);

}

DDRotation::DDRotation	(	const DDName &	name,
		DDRotationMatrix *	rot
	)

Definition at line 67 of file DDRotation.cc.

References DDI::Singleton< I >::instance(), and DDBase< DDName, DDRotationMatrix * >::prep_.

 : DDBase<DDName,DDRotationMatrix*>()
{
  prep_ = StoreT::instance().create(name,rot);

}

DDRotation::DDRotation ( DDRotationMatrix *  rot )

private

Definition at line 75 of file DDRotation.cc.

References DDI::Singleton< I >::instance(), and DDBase< DDName, DDRotationMatrix * >::prep_.

 : DDBase<DDName,DDRotationMatrix*>()
{
  static std::atomic<int> countNN;
  char buf[64];
  snprintf(buf, 64, "DdNoNa%i", countNN++);
  prep_ = StoreT::instance().create(DDName(buf, "DdNoNa"), rot);
  //  std::cout << "making a NO-NAME " << buf << " named rotation, " << prep_->second << std::endl;
}

Member Function Documentation

DDRotationMatrix* DDRotation::matrix ( void  )

inline

Definition at line 92 of file DDTransform.h.

References DDRotation(), and rotation().

Referenced by TGeoMgrFromDdd::createShape(), TGeoFromDddService::createShape(), DDHtmlRoDetails::details(), DDTrackerRingAlgo::execute(), DDCoreToDDXMLOutput::position(), and DDCoreToDDXMLOutput::rotation().

{ return rotation(); }

const DDRotationMatrix* DDRotation::rotation ( void  ) const

inline

Returns the read-only rotation-matrix.

Definition at line 88 of file DDTransform.h.

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

Referenced by dd_rot_out(), DDPixFwdBlades::execute(), DDG4SolidConverter::intersection(), matrix(), DDCompareDDRot::operator()(), operator<<(), DDPosData::rot(), DDPosData::rotation(), DDG4SolidConverter::subtraction(), and DDG4SolidConverter::unionsolid().

{ return &(rep()); }   

DDRotationMatrix* DDRotation::rotation ( void  )

inline

Definition at line 90 of file DDTransform.h.

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

{ return &(rep()); }

Friends And Related Function Documentation

DDRotation DDanonymousRot ( 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 187 of file DDRotation.cc.

{
  return DDRotation(rot);
}

DDRotation DDrot ( const DDName &  name, 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 90 of file DDRotation.cc.

{
   // memory of rot goes sto DDRotationImpl!!
   return DDRotation(ddname, rot);
}

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 131 of file DDRotation.cc.

{
   
   // define 3 unit std::vectors forming the new left-handed axes 
   DD3Vector x(cos(phiX)*sin(thetaX), sin(phiX)*sin(thetaX), cos(thetaX));
   DD3Vector y(cos(phiY)*sin(thetaY), sin(phiY)*sin(thetaY), cos(thetaY));
   DD3Vector z(cos(phiZ)*sin(thetaZ), sin(phiZ)*sin(thetaZ), cos(thetaZ));
   
   double tol = 1.0e-3; // Geant4 compatible
   double check = (x.Cross(y)).Dot(z); // in case of a LEFT-handed orthogonal system this must be -1
   if (fabs(1.+check)>tol) {
     edm::LogError("DDRotation") << ddname << " is not a LEFT-handed orthonormal matrix!" << std::endl;
     throw cms::Exception("DDException") << ddname.name() << " is not LEFT-handed!";
   }
   
   DDRotationMatrix* rot = new DDRotationMatrix(x.x(),y.x(),z.x(),
                        x.y(),y.y(),z.y(),
                        x.z(),y.z(),z.z());

   return DDRotation(ddname, rot);  
}       

std::ostream& operator<< ( std::ostream &  os, const DDRotation &  r  )

friend

Definition at line 21 of file DDRotation.cc.

{
  DDBase<DDName,DDRotationMatrix*>::def_type defined(r.isDefined());
  if (defined.first) {
    os << *(defined.first) << " ";
    if (defined.second) {
      const DDRotationMatrix & rm = *(r.rotation());
      DDAxisAngle   ra(rm);
      os << "t=" << ra.Axis().Theta()/deg << "deg "
         << "p=" << ra.Axis().Phi()/deg << "deg "
     << "a=" << ra.Angle()/deg << "deg"; 
    }
    else {
      os << "* rotation not defined * ";  
    }
  }  
  else {
    os << "* rotation not declared * ";  
  }  
  return os;
}