TrackParametersIdHelper.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRK_TRACKPARAMETERSIDHELPER_H
#define TRK_TRACKPARAMETERSIDHELPER_H
 
#include "TrkParametersIdentificationHelpers/BitField.h"
 
#include "CaloGeoHelpers/CaloSampling.h"
#include "AtlasDetDescr/AtlasDetTechnology.h"
 
typedef unsigned int TrackParametersIdentifier;
 
namespace Trk {

  class TrackParametersIdHelper {
  public:
    // Avoid cppcheck warnings.
    TrackParametersIdHelper() = default;

    TrackParametersIdentifier          encode( AtlasDetDescr::AtlasDetTechnology, CaloSampling::CaloSample,
                                               bool isEntryToVolume ) const;

    TrackParametersIdentifier          encodeInValidIdentifier() const;

    bool                               isValid( TrackParametersIdentifier id ) const;

    bool                               isEntryToVolume( TrackParametersIdentifier id ) const;

    AtlasDetDescr::AtlasDetTechnology  technology( TrackParametersIdentifier id ) const;

    CaloSampling::CaloSample           caloSample( TrackParametersIdentifier id ) const;
 
  private:
    void setVersion( TrackParametersIdentifier& id ) const;
 
    static const unsigned int           m_version;
    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;
 
  };
 
 inline TrackParametersIdentifier TrackParametersIdHelper::encode( AtlasDetDescr::AtlasDetTechnology tech, 
                                                                   CaloSampling::CaloSample sample,
                                                                   bool isEntryToVolume ) const {
    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;
  }
 
  inline bool TrackParametersIdHelper::isValid( TrackParametersIdentifier id ) const {
    return !m_validField.decode(id);
  }
 
  inline bool TrackParametersIdHelper::isEntryToVolume( TrackParametersIdentifier id ) const {
    return m_isEntryToLayerField.decode(id);
  }
 
  inline AtlasDetDescr::AtlasDetTechnology TrackParametersIdHelper::technology( TrackParametersIdentifier id ) const {
    // check if identifier is valid
    if( !isValid(id) ) { return AtlasDetDescr::fUndefined;}
    return static_cast<AtlasDetDescr::AtlasDetTechnology>(m_technologyField.decode(id));
  }
  
  inline CaloSampling::CaloSample TrackParametersIdHelper::caloSample( TrackParametersIdentifier id ) const {
    // check if identifier is valid
    if( !isValid(id) ) { return CaloSampling::Unknown;}
    return static_cast<CaloSampling::CaloSample>(m_caloSamplingField.decode(id));
  }
 
  inline void TrackParametersIdHelper::setVersion( TrackParametersIdentifier& id ) const {
     m_versionField.encode(m_version,id);
  }
 
  inline TrackParametersIdentifier TrackParametersIdHelper::encodeInValidIdentifier() const {
    TrackParametersIdentifier id(0);
    m_validField.encode(1,id);
    return id;
  }
 
}
 
#endif