TOPGeoModuleDisplacement Class Reference

Displacement parameters of a TOP module. More...

#include <TOPGeoModuleDisplacement.h>

Inheritance diagram for TOPGeoModuleDisplacement:

Collaboration diagram for TOPGeoModuleDisplacement:

Public Member Functions
	TOPGeoModuleDisplacement ()
	Default constructor.
	TOPGeoModuleDisplacement (double x, double y, double z, double alpha, double beta, double gamma, const std::string &name="TOPModuleDisplacement")
	Full constructor. More...
double	getX () const
	Returns translation in x. More...
double	getY () const
	Returns translation in y. More...
double	getZ () const
	Returns translation in z. More...
double	getAlpha () const
	Returns rotation angle around x. More...
double	getBeta () const
	Returns rotation angle around y. More...
double	getGamma () const
	Returns rotation angle around z. More...
TRotation	getRotation () const
	Returns rotation matrix. More...
TVector3	getTranslation () const
	Returns translation vector (always in basf2 units!) More...
bool	isConsistent () const override
	Check for consistency of data members. More...
void	print (const std::string &title="Module displacement parameters") const override
	Print the content of the class. More...
void	setName (const std::string &name)
	Sets object name. More...
const std::string &	getName () const
	Returns object name. More...
virtual void	printSurface (const GeoOpticalSurface &surface) const
	Print the content of optical surface. More...
double	getReflectivity (const GeoOpticalSurface &surface, double energy) const
	Returns reflectivity of optical surface at given photon energy. More...

Protected Member Functions
void	printUnderlined (const std::string &title) const
	Print the content of the class. More...
	ClassDef (TOPGeoBase, 1)
	ClassDef.

Protected Attributes
std::string	m_name
	geometry object name

Static Protected Attributes
static double	s_unit = Unit::cm
	conversion unit for length
static std::string	s_unitName
	conversion unit name

Private Member Functions
	ClassDefOverride (TOPGeoModuleDisplacement, 1)
	ClassDef.

Private Attributes
float	m_x = 0
	translation in x
float	m_y = 0
	translation in y
float	m_z = 0
	translation in z
float	m_alpha = 0
	rotation angle around x
float	m_beta = 0
	rotation angle around y
float	m_gamma = 0
	rotation angle around z

Detailed Description

Displacement parameters of a TOP module.

To displace module: rotation first (around x, then y, then z), then translation (e.g. going from local to nominal frame)

Definition at line 26 of file TOPGeoModuleDisplacement.h.

Constructor & Destructor Documentation

TOPGeoModuleDisplacement()

TOPGeoModuleDisplacement ( double  x, double  y, double  z, double  alpha, double  beta, double  gamma, const std::string &  name = "TOPModuleDisplacement"  )

inline

Full constructor.

Parameters

x	translation in x
y	translation in y
z	translation in z
alpha	rotation angle around x
beta	rotation angle around y
gamma	rotation angle around z
name	object name

Definition at line 45 of file TOPGeoModuleDisplacement.h.

                                                                             :
      TOPGeoBase(name),
      m_x(x), m_y(y), m_z(z),
      m_alpha(alpha), m_beta(beta), m_gamma(gamma)
    {}

Member Function Documentation

getAlpha()

double getAlpha ( ) const

inline

Returns rotation angle around x.

Returns

rotation angle

Definition at line 75 of file TOPGeoModuleDisplacement.h.

getBeta()

double getBeta ( ) const

inline

Returns rotation angle around y.

Returns

rotation angle

Definition at line 81 of file TOPGeoModuleDisplacement.h.

getGamma()

double getGamma ( ) const

inline

Returns rotation angle around z.

Returns

rotation angle

Definition at line 87 of file TOPGeoModuleDisplacement.h.

getName()

const std::string& getName ( void  ) const

inlineinherited

Returns object name.

Returns

object name

Definition at line 51 of file TOPGeoBase.h.

getRotation()

TRotation getRotation ( void  ) const

inline

Returns rotation matrix.

Returns

rotation matrix

Definition at line 93 of file TOPGeoModuleDisplacement.h.

getTranslation()

TVector3 getTranslation ( ) const

inline

Returns translation vector (always in basf2 units!)

Returns

translation vector

Definition at line 104 of file TOPGeoModuleDisplacement.h.

getX()

double getX ( ) const

inline

Returns translation in x.

Returns

x coordinate

Definition at line 57 of file TOPGeoModuleDisplacement.h.

getY()

double getY ( ) const

inline

Returns translation in y.

Returns

y coordinate

Definition at line 63 of file TOPGeoModuleDisplacement.h.

getZ()

double getZ ( ) const

inline

Returns translation in z.

Returns

z coordinate

Definition at line 69 of file TOPGeoModuleDisplacement.h.

isConsistent()

bool isConsistent ( ) const

inlineoverridevirtual

Check for consistency of data members.

Returns

true if values consistent (valid)

Reimplemented from TOPGeoBase.

Definition at line 110 of file TOPGeoModuleDisplacement.h.

setName()

void setName ( const std::string &  name )

inlineinherited

Sets object name.

Parameters

name	object name

Definition at line 45 of file TOPGeoBase.h.

---

The documentation for this class was generated from the following files:

• top/dbobjects/include/TOPGeoModuleDisplacement.h
• top/dbobjects/src/TOPGeoModuleDisplacement.cc