CbmRoot
Loading...
Searching...
No Matches
cbm::algo::ca::Station< DataT > Class Template Reference

#include <CaStation.h>

Inheritance diagram for cbm::algo::ca::Station< DataT >:
[legend]
Collaboration diagram for cbm::algo::ca::Station< DataT >:
[legend]

Public Member Functions

 Station ()=default
 
template<typename DataIn >
 Station (const Station< DataIn > &other)
 Copy constructor with type conversion.
 
template<class Archive >
void serialize (Archive &ar, const unsigned int)
 
void CheckConsistency () const
 Verifies class invariant consistency.
 
int GetType () const
 Gets type of the station.
 
int GetTimeStatus () const
 Gets time-measurement flag.
 
int GetFieldStatus () const
 Gets field status flag.
 
int GetGeoLayerID () const
 Gets index of the layer in the geometry setup (which can include inactive stations as well)
 
template<typename DataOut = DataT>
DataOut GetZ () const
 Gets z-position of the station.
 
template<typename DataOut = DataT>
DataOut GetXmax () const
 Gets limit of the station size in x-axis direction.
 
template<typename DataOut = DataT>
DataOut GetXmin () const
 Gets limit of the station size in x-axis direction.
 
template<typename DataOut = DataT>
DataOut GetYmax () const
 Gets limit of the station size in y-axis direction.
 
template<typename DataOut = DataT>
DataOut GetYmin () const
 Gets limit of the station size in y-axis direction.
 
std::string ToString (int verbosityLevel=0, int indentLevel=0, bool isHeader=false) const
 String representation of class contents.
 

Public Attributes

int type = constants::Undef<int>
 
int timeInfo = constants::Undef<int>
 flag: if time information can be used
 
int fieldStatus
 flag: 1 - station is INSIDE the field, 0 - station is OUTSIDE the field
 
int geoLayerID = constants::Undef<int>
 Index of layer in geometrical setup.
 
DataT fZ = constants::Undef<DataT>
 z position of station [cm]
 
DataT Xmax = constants::Undef<DataT>
 min radius of the station [cm]
 
DataT Ymax = constants::Undef<DataT>
 max radius of the station [cm]
 
kf::FieldSlice< DataT > fieldSlice {}
 Magnetic field near the station.
 

Friends

class boost::serialization::access
 

Detailed Description

template<typename DataT>
class cbm::algo::ca::Station< DataT >

Structure Station Contains a set of geometry parameters for a particular station

Definition at line 19 of file CaStation.h.

Constructor & Destructor Documentation

◆ Station() [1/2]

template<typename DataT >
cbm::algo::ca::Station< DataT >::Station ( )
default

◆ Station() [2/2]

template<typename DataT >
template<typename DataIn >
cbm::algo::ca::Station< DataT >::Station ( const Station< DataIn > & other)
inline

Copy constructor with type conversion.

Definition at line 39 of file CaStation.h.

Member Function Documentation

◆ CheckConsistency()

template<typename DataT >
void cbm::algo::ca::Station< DataT >::CheckConsistency ( ) const

Verifies class invariant consistency.

Note
Object is considered undefined in the creation time, so this function should be called after the object initialization

Integer fields initialization checks

SIMD vector checks: all the words in a SIMD vector must be equal

Inner and outer radia checks: (i) both Xmax and Ymax must be > 0

Check consistency of other members

Definition at line 17 of file CaStation.cxx.

References cbm::algo::kf::utils::CheckSimdVectorEquality(), and cbm::algo::ToString().

◆ GetFieldStatus()

template<typename DataT >
int cbm::algo::ca::Station< DataT >::GetFieldStatus ( ) const
inline

Gets field status flag.

Definition at line 80 of file CaStation.h.

References cbm::algo::ca::Station< DataT >::fieldStatus.

◆ GetGeoLayerID()

template<typename DataT >
int cbm::algo::ca::Station< DataT >::GetGeoLayerID ( ) const
inline

Gets index of the layer in the geometry setup (which can include inactive stations as well)

Definition at line 83 of file CaStation.h.

References cbm::algo::ca::Station< DataT >::geoLayerID.

◆ GetTimeStatus()

template<typename DataT >
int cbm::algo::ca::Station< DataT >::GetTimeStatus ( ) const
inline

Gets time-measurement flag.

Definition at line 77 of file CaStation.h.

References cbm::algo::ca::Station< DataT >::timeInfo.

◆ GetType()

template<typename DataT >
int cbm::algo::ca::Station< DataT >::GetType ( ) const
inline

Gets type of the station.

Definition at line 74 of file CaStation.h.

References cbm::algo::ca::Station< DataT >::type.

◆ GetXmax()

template<typename DataT >
template<typename DataOut = DataT>
DataOut cbm::algo::ca::Station< DataT >::GetXmax ( ) const
inline

Gets limit of the station size in x-axis direction.

Definition at line 94 of file CaStation.h.

References cbm::algo::ca::Station< DataT >::Xmax.

Referenced by cbm::ca::TimeSliceReader::ReadHitsForDetector().

◆ GetXmin()

template<typename DataT >
template<typename DataOut = DataT>
DataOut cbm::algo::ca::Station< DataT >::GetXmin ( ) const
inline

Gets limit of the station size in x-axis direction.

Definition at line 101 of file CaStation.h.

References cbm::algo::ca::Station< DataT >::Xmax.

Referenced by cbm::ca::TimeSliceReader::ReadHitsForDetector().

◆ GetYmax()

template<typename DataT >
template<typename DataOut = DataT>
DataOut cbm::algo::ca::Station< DataT >::GetYmax ( ) const
inline

Gets limit of the station size in y-axis direction.

Definition at line 108 of file CaStation.h.

References cbm::algo::ca::Station< DataT >::Ymax.

Referenced by cbm::ca::TimeSliceReader::ReadHitsForDetector().

◆ GetYmin()

template<typename DataT >
template<typename DataOut = DataT>
DataOut cbm::algo::ca::Station< DataT >::GetYmin ( ) const
inline

Gets limit of the station size in y-axis direction.

Definition at line 115 of file CaStation.h.

References cbm::algo::ca::Station< DataT >::Ymax.

Referenced by cbm::ca::TimeSliceReader::ReadHitsForDetector().

◆ GetZ()

template<typename DataT >
template<typename DataOut = DataT>
DataOut cbm::algo::ca::Station< DataT >::GetZ ( ) const
inline

Gets z-position of the station.

Definition at line 87 of file CaStation.h.

References cbm::algo::ca::Station< DataT >::fZ.

Referenced by cbm::ca::TimeSliceReader::ReadHitsForDetector().

◆ serialize()

◆ ToString()

template<typename DataT >
std::string cbm::algo::ca::Station< DataT >::ToString ( int verbosityLevel = 0,
int indentLevel = 0,
bool isHeader = false ) const

String representation of class contents.

Parameters
verbosityLevelVerbosity level of the output
indentLevelNumber of indent characters in the output

Definition at line 70 of file CaStation.cxx.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<typename DataT >
friend class boost::serialization::access
friend

Definition at line 52 of file CaStation.h.

Member Data Documentation

◆ fieldSlice

◆ fieldStatus

template<typename DataT >
int cbm::algo::ca::Station< DataT >::fieldStatus
Initial value:

flag: 1 - station is INSIDE the field, 0 - station is OUTSIDE the field

Definition at line 26 of file CaStation.h.

Referenced by cbm::algo::ca::Station< DataT >::GetFieldStatus(), and cbm::algo::ca::Station< DataT >::serialize().

◆ fZ

◆ geoLayerID

template<typename DataT >
int cbm::algo::ca::Station< DataT >::geoLayerID = constants::Undef<int>

Index of layer in geometrical setup.

Definition at line 28 of file CaStation.h.

Referenced by cbm::algo::ca::Station< DataT >::GetGeoLayerID(), and cbm::algo::ca::Station< DataT >::serialize().

◆ timeInfo

◆ type

template<typename DataT >
int cbm::algo::ca::Station< DataT >::type = constants::Undef<int>

◆ Xmax

template<typename DataT >
DataT cbm::algo::ca::Station< DataT >::Xmax = constants::Undef<DataT>

◆ Ymax

template<typename DataT >
DataT cbm::algo::ca::Station< DataT >::Ymax = constants::Undef<DataT>

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