Trk::TrackParametersIdHelper Class Reference

helper class to encode and decode a TrackParametersIdentifier More...

#include <TrackParametersIdHelper.h>

Collaboration diagram for Trk::TrackParametersIdHelper:

Public Member Functions
	TrackParametersIdHelper ()=default
TrackParametersIdentifier	encode (AtlasDetDescr::AtlasDetTechnology, CaloSampling::CaloSample, bool isEntryToVolume) const
	Encodes a TrackParametersIdentifier from AtlasDetDescr::AtlasDetTechnology and CaloSampling::CaloSample and a bool indicating whether this is an entry or exit layer. More...
TrackParametersIdentifier	encodeInValidIdentifier () const
	create invalid identifier More...
bool	isValid (TrackParametersIdentifier id) const
	returns true if the id is valid More...
bool	isEntryToVolume (TrackParametersIdentifier id) const
	returns true if the id belongs to the volume entrance More...
AtlasDetDescr::AtlasDetTechnology	technology (TrackParametersIdentifier id) const
	AtlasDetTechnology encoded in id, returns AtlasDetDescr::fUndefined if id is not valid. More...
CaloSampling::CaloSample	caloSample (TrackParametersIdentifier id) const
	CaloSample encoded in id, returns CaloSampling::Unknown if id is not valid More...

Private Member Functions
void	setVersion (TrackParametersIdentifier &id) const
	set version bits More...

Static Private Attributes
static const unsigned int	m_version = 0
static const BitField< unsigned int >	m_validField
static const BitField< unsigned int >	m_versionField
static const BitField< unsigned int >	m_technologyField
static const BitField< unsigned int >	m_isEntryToLayerField
static const BitField< unsigned int >	m_caloSamplingField

Detailed Description

helper class to encode and decode a TrackParametersIdentifier

Definition at line 18 of file TrackParametersIdHelper.h.

Constructor & Destructor Documentation

TrackParametersIdHelper()

Trk::TrackParametersIdHelper::TrackParametersIdHelper ( )

default

Member Function Documentation

caloSample()

CaloSampling::CaloSample Trk::TrackParametersIdHelper::caloSample ( TrackParametersIdentifier  id ) const

inline

CaloSample encoded in id, returns CaloSampling::Unknown if id is not valid

Definition at line 91 of file TrackParametersIdHelper.h.

                                                                                                        {
    // check if identifier is valid
    if( !isValid(id) ) { return CaloSampling::Unknown;}
    return static_cast<CaloSampling::CaloSample>(m_caloSamplingField.decode(id));
  }

encode()

TrackParametersIdentifier Trk::TrackParametersIdHelper::encode ( AtlasDetDescr::AtlasDetTechnology  tech, CaloSampling::CaloSample  sample, bool  isEntryToVolume  ) const

inline

Encodes a TrackParametersIdentifier from AtlasDetDescr::AtlasDetTechnology and CaloSampling::CaloSample and a bool indicating whether this is an entry or exit layer.

Checks consistency of technology and calo sample and will create an invalid identifier is any of the inputs is inconsistent

Definition at line 60 of file TrackParametersIdHelper.h.

                                                                                                {
    TrackParametersIdentifier id = 0;
    // check whether techology matches calo
    if( tech < AtlasDetDescr::fFirstAtlasCaloTechnology || tech > AtlasDetDescr::fLastAtlasCaloTechnology ){
      m_validField.encode(1,id);
    }else{
      m_technologyField.encode(tech,id);
      unsigned int ientry = isEntryToVolume ? 1 : 0;
      m_isEntryToLayerField.encode(ientry,id);
      m_caloSamplingField.encode(sample,id);
      setVersion(id);
    }
    return id;
  }

encodeInValidIdentifier()

TrackParametersIdentifier Trk::TrackParametersIdHelper::encodeInValidIdentifier ( ) const

inline

create invalid identifier

Definition at line 101 of file TrackParametersIdHelper.h.

                                                                                          {
    TrackParametersIdentifier id(0);
    m_validField.encode(1,id);
    return id;
  }

isEntryToVolume()

bool Trk::TrackParametersIdHelper::isEntryToVolume ( TrackParametersIdentifier  id ) const

inline

returns true if the id belongs to the volume entrance

Definition at line 81 of file TrackParametersIdHelper.h.

                                                                                           {
    return m_isEntryToLayerField.decode(id);
  }

isValid()

bool Trk::TrackParametersIdHelper::isValid ( TrackParametersIdentifier  id ) const

inline

returns true if the id is valid

Definition at line 77 of file TrackParametersIdHelper.h.

                                                                                   {
    return !m_validField.decode(id);
  }

setVersion()

void Trk::TrackParametersIdHelper::setVersion ( TrackParametersIdentifier &  id ) const

inlineprivate

set version bits

Definition at line 97 of file TrackParametersIdHelper.h.

                                                                                       {
     m_versionField.encode(m_version,id);
  }

technology()

AtlasDetDescr::AtlasDetTechnology Trk::TrackParametersIdHelper::technology ( TrackParametersIdentifier  id ) const

inline

AtlasDetTechnology encoded in id, returns AtlasDetDescr::fUndefined if id is not valid.

Definition at line 85 of file TrackParametersIdHelper.h.

                                                                                                                 {
    // check if identifier is valid
    if( !isValid(id) ) { return AtlasDetDescr::fUndefined;}
    return static_cast<AtlasDetDescr::AtlasDetTechnology>(m_technologyField.decode(id));
  }

Member Data Documentation

m_caloSamplingField

const BitField< unsigned int > Trk::TrackParametersIdHelper::m_caloSamplingField

staticprivate

Definition at line 56 of file TrackParametersIdHelper.h.

m_isEntryToLayerField

const BitField< unsigned int > Trk::TrackParametersIdHelper::m_isEntryToLayerField

staticprivate

Definition at line 55 of file TrackParametersIdHelper.h.

m_technologyField

const BitField< unsigned int > Trk::TrackParametersIdHelper::m_technologyField

staticprivate

Definition at line 53 of file TrackParametersIdHelper.h.

m_validField

const BitField< unsigned int > Trk::TrackParametersIdHelper::m_validField

staticprivate

Definition at line 51 of file TrackParametersIdHelper.h.

m_version

const unsigned int Trk::TrackParametersIdHelper::m_version = 0

staticprivate

Definition at line 50 of file TrackParametersIdHelper.h.

m_versionField

const BitField< unsigned int > Trk::TrackParametersIdHelper::m_versionField

staticprivate

Definition at line 52 of file TrackParametersIdHelper.h.

---

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

• TrackParametersIdHelper.h
• TrackParametersIdHelper.cxx