CbmRoot
Loading...
Searching...
No Matches
cbm::algo::kf::ActiveLayer< F > Class Template Reference

Properties of an active surface of the layer. More...

#include <KfActiveLayer.h>

Inheritance diagram for cbm::algo::kf::ActiveLayer< F >:
[legend]

Public Member Functions

 ActiveLayer (F zRef, F xMin, F xMax, F yMin, F yMax, EFieldType fieldType, bool isTimeMeasured)
 Constructor.
 
template<typename FSrc>
 ActiveLayer (const ActiveLayer< FSrc > &other)
 Type conversion copy constructor.
 
 ActiveLayer (const ActiveLayer &)=default
 Standard copy constructor.
 
 ActiveLayer (ActiveLayer &&)=default
 Move constructor.
 
ActiveLayeroperator= (const ActiveLayer &)=default
 Copy assignment operator.
 
ActiveLayeroperator= (ActiveLayer &&)=default
 Move assignment operator.
 
F GetZref () const
 Gets reference z-coordinate of the layer [cm].
 
F GetXmin () const
 Gets lower bound in x-direction [cm].
 
F GetXmax () const
 Gets upper bound in x-direction [cm].
 
F GetYmin () const
 Gets lower bound in y-direction [cm].
 
F GetYmax () const
 Gets upper bound in y-direction [cm].
 
EFieldType GetFieldType () const
 Gets field type.
 
bool IsInField () const
 Checks, if the layer is in magnetic field.
 
bool IsTimeMeasured () const
 Checks, if time measurement available.
 
std::string ToString (int indentLevel=0) const
 String representation of the class.
 

Private Member Functions

 ActiveLayer ()=default
 Default constructor (for serialization)
 
template<class Archive>
void serialize (Archive &ar, const unsigned int)
 Serialization method.
 

Private Attributes

F fZref {defs::Undef<F>}
 reference z-coordinate of the layer [cm]
 
F fXmin {defs::Undef<F>}
 lower bound for active plane in x-direction [cm]
 
F fXmax {defs::Undef<F>}
 upper bound for active plane in x-direction [cm]
 
F fYmin {defs::Undef<F>}
 lower bound for active plane in y-direction [cm]
 
F fYmax {defs::Undef<F>}
 upper bound for active plane in y-direction [cm]
 
EFieldType fFieldType {EFieldType::Null}
 Type of magnetic field near the layer.
 
bool fTimeInfo {false}
 If time-measurement accessible.
 

Friends

template<typename>
class ActiveLayer
 
class boost::serialization::access
 

Detailed Description

template<typename F>
class cbm::algo::kf::ActiveLayer< F >

Properties of an active surface of the layer.

Template Parameters
FA type of floating point

Definition at line 25 of file KfActiveLayer.h.

Constructor & Destructor Documentation

◆ ActiveLayer() [1/5]

template<typename F>
ActiveLayer::ActiveLayer ( F zRef,
F xMin,
F xMax,
F yMin,
F yMax,
EFieldType fieldType,
bool isTimeMeasured )

Constructor.

Parameters
zRefreference z-coordinate of active plane [cm]
xMinlower bound for active plane in x-direction [cm]
xMaxupper bound for active plane in x-direction [cm]
yMinlower bound for active plane in y-direction [cm]
yMaxupper bound for active plane in y-direction [cm]
fieldTypeA type of the field
isTimeMeasuredIf the layer has time measurement

Definition at line 20 of file KfActiveLayer.cxx.

References F, fFieldType, fTimeInfo, fXmax, fXmin, fYmax, fYmin, and fZref.

◆ ActiveLayer() [2/5]

template<typename F>
template<typename FSrc>
cbm::algo::kf::ActiveLayer< F >::ActiveLayer ( const ActiveLayer< FSrc > & other)
inline

Type conversion copy constructor.

Template Parameters
FSrcFloating point type of the source
Parameters
otherOther instance

Definition at line 45 of file KfActiveLayer.h.

References ActiveLayer, F, fFieldType, fTimeInfo, fXmax, fXmin, fYmax, fYmin, and fZref.

◆ ActiveLayer() [3/5]

template<typename F>
cbm::algo::kf::ActiveLayer< F >::ActiveLayer ( const ActiveLayer< F > & )
default

Standard copy constructor.

References ActiveLayer.

◆ ActiveLayer() [4/5]

template<typename F>
cbm::algo::kf::ActiveLayer< F >::ActiveLayer ( ActiveLayer< F > && )
default

Move constructor.

References ActiveLayer.

◆ ActiveLayer() [5/5]

template<typename F>
cbm::algo::kf::ActiveLayer< F >::ActiveLayer ( )
privatedefault

Default constructor (for serialization)

Member Function Documentation

◆ GetFieldType()

template<typename F>
EFieldType cbm::algo::kf::ActiveLayer< F >::GetFieldType ( ) const
inline

Gets field type.

Definition at line 84 of file KfActiveLayer.h.

References fFieldType.

◆ GetXmax()

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::GetXmax ( ) const
inline

Gets upper bound in x-direction [cm].

Definition at line 75 of file KfActiveLayer.h.

References F, and fXmax.

◆ GetXmin()

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::GetXmin ( ) const
inline

Gets lower bound in x-direction [cm].

Definition at line 72 of file KfActiveLayer.h.

References F, and fXmin.

◆ GetYmax()

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::GetYmax ( ) const
inline

Gets upper bound in y-direction [cm].

Definition at line 81 of file KfActiveLayer.h.

References F, and fYmax.

◆ GetYmin()

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::GetYmin ( ) const
inline

Gets lower bound in y-direction [cm].

Definition at line 78 of file KfActiveLayer.h.

References F, and fYmin.

◆ GetZref()

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::GetZref ( ) const
inline

Gets reference z-coordinate of the layer [cm].

Definition at line 69 of file KfActiveLayer.h.

References F, and fZref.

◆ IsInField()

template<typename F>
bool cbm::algo::kf::ActiveLayer< F >::IsInField ( ) const
inline

Checks, if the layer is in magnetic field.

Definition at line 87 of file KfActiveLayer.h.

References fFieldType, and cbm::algo::kf::Null.

◆ IsTimeMeasured()

template<typename F>
bool cbm::algo::kf::ActiveLayer< F >::IsTimeMeasured ( ) const
inline

Checks, if time measurement available.

Definition at line 90 of file KfActiveLayer.h.

References fTimeInfo.

Referenced by cbm::algo::ca::TripletConstructor::CollectHits().

◆ operator=() [1/2]

template<typename F>
ActiveLayer & cbm::algo::kf::ActiveLayer< F >::operator= ( ActiveLayer< F > && )
default

Move assignment operator.

References ActiveLayer.

◆ operator=() [2/2]

template<typename F>
ActiveLayer & cbm::algo::kf::ActiveLayer< F >::operator= ( const ActiveLayer< F > & )
default

Copy assignment operator.

References ActiveLayer.

◆ serialize()

template<typename F>
template<class Archive>
void cbm::algo::kf::ActiveLayer< F >::serialize ( Archive & ar,
const unsigned int  )
inlineprivate

Serialization method.

Definition at line 110 of file KfActiveLayer.h.

References fFieldType, fTimeInfo, fXmax, fXmin, fYmax, fYmin, and fZref.

◆ ToString()

template<typename F>
std::string ActiveLayer::ToString ( int indentLevel = 0) const

String representation of the class.

Parameters
indentLevelIndent level of the string output

Definition at line 34 of file KfActiveLayer.cxx.

Friends And Related Symbol Documentation

◆ ActiveLayer

template<typename F>
template<typename>
friend class ActiveLayer
friend

◆ boost::serialization::access

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

Definition at line 28 of file KfActiveLayer.h.

References ActiveLayer, and F.

Member Data Documentation

◆ fFieldType

template<typename F>
EFieldType cbm::algo::kf::ActiveLayer< F >::fFieldType {EFieldType::Null}
private

Type of magnetic field near the layer.

Definition at line 102 of file KfActiveLayer.h.

Referenced by ActiveLayer(), ActiveLayer(), GetFieldType(), IsInField(), and serialize().

◆ fTimeInfo

template<typename F>
bool cbm::algo::kf::ActiveLayer< F >::fTimeInfo {false}
private

If time-measurement accessible.

Definition at line 103 of file KfActiveLayer.h.

Referenced by ActiveLayer(), ActiveLayer(), IsTimeMeasured(), and serialize().

◆ fXmax

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::fXmax {defs::Undef<F>}
private

upper bound for active plane in x-direction [cm]

Definition at line 99 of file KfActiveLayer.h.

Referenced by ActiveLayer(), ActiveLayer(), GetXmax(), and serialize().

◆ fXmin

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::fXmin {defs::Undef<F>}
private

lower bound for active plane in x-direction [cm]

Definition at line 98 of file KfActiveLayer.h.

Referenced by ActiveLayer(), ActiveLayer(), GetXmin(), and serialize().

◆ fYmax

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::fYmax {defs::Undef<F>}
private

upper bound for active plane in y-direction [cm]

Definition at line 101 of file KfActiveLayer.h.

Referenced by ActiveLayer(), ActiveLayer(), GetYmax(), and serialize().

◆ fYmin

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::fYmin {defs::Undef<F>}
private

lower bound for active plane in y-direction [cm]

Definition at line 100 of file KfActiveLayer.h.

Referenced by ActiveLayer(), ActiveLayer(), GetYmin(), and serialize().

◆ fZref

template<typename F>
F cbm::algo::kf::ActiveLayer< F >::fZref {defs::Undef<F>}
private

reference z-coordinate of the layer [cm]

Definition at line 97 of file KfActiveLayer.h.

Referenced by ActiveLayer(), ActiveLayer(), GetZref(), and serialize().


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