ldas-tools-framecpp  2.7.0
Classes | Public Member Functions | Private Types | Private Attributes | List of all members
FrameCPP::Common::DetectorNames Class Reference

Maintains information about known detectors. More...

#include <DetectorNames.hh>

Classes

struct  info_type
 Information describing a detector. More...
 

Public Member Functions

 DetectorNames ()
 Constructor. More...
 
const info_typeDetector (const std::string &Name) const
 Get information about a detector. More...
 
void Freeze ()
 Prevent any further modifications to the structure. More...
 
void operator() (const std::string &DetectorName, const std::string &Detector, const std::string &Prefix, const std::pair< int, int > DataQualityBits)
 Add new element to the table. More...
 
 DetectorNames ()
 Constructor. More...
 
const info_typeDetector (const std::string &Name) const
 Get information about a detector. More...
 
void Freeze ()
 Prevent any further modifications to the structure. More...
 
void operator() (const std::string &DetectorName, const std::string &Detector, const std::string &Prefix, const std::pair< int, int > DataQualityBits)
 Add new element to the table. More...
 

Private Types

typedef LDASTools::AL::unordered_map< std::string, info_typedetector_info_container_type
 Container of detector information. More...
 
typedef LDASTools::AL::unordered_map< std::string, info_typedetector_info_container_type
 Container of detector information. More...
 

Private Attributes

bool m_frozen
 State variable for frozen state. More...
 
detector_info_container_type m_info
 Storage for detector information. More...
 

Detailed Description

Maintains information about known detectors.

Member Typedef Documentation

◆ detector_info_container_type [1/2]

typedef LDASTools::AL::unordered_map< std::string, info_type > FrameCPP::Common::DetectorNames::detector_info_container_type
private

Container of detector information.

◆ detector_info_container_type [2/2]

typedef LDASTools::AL::unordered_map< std::string, info_type > FrameCPP::Common::DetectorNames::detector_info_container_type
private

Container of detector information.

Constructor & Destructor Documentation

◆ DetectorNames() [1/2]

FrameCPP::Common::DetectorNames::DetectorNames ( )

Constructor.

The default constructor is used to ensure proper initialization of the data elements.

◆ DetectorNames() [2/2]

FrameCPP::Common::DetectorNames::DetectorNames ( )

Constructor.

Member Function Documentation

◆ Detector() [1/2]

const DetectorNames::info_type & FrameCPP::Common::DetectorNames::Detector ( const std::string &  Name) const

Get information about a detector.

This method retrieves information about a detector.

Parameters
[in]NameThe name of the detector as listed in the FrDetector structure.
Returns
Information associated with the detector.
Exceptions
std::range_errorThis exception is thrown if the Name parameter does not reference an entry in the set of detectors.

◆ Detector() [2/2]

const info_type& FrameCPP::Common::DetectorNames::Detector ( const std::string &  Name) const

Get information about a detector.

Parameters
[in]NameThe name of the detector as listed in the FrDetector structure.
Returns
Information associated with the detector.

◆ Freeze() [1/2]

void FrameCPP::Common::DetectorNames::Freeze ( )
inline

Prevent any further modifications to the structure.

Prevent further additions to the set of detectors.

◆ Freeze() [2/2]

void FrameCPP::Common::DetectorNames::Freeze ( )

Prevent any further modifications to the structure.

◆ operator()() [1/2]

void FrameCPP::Common::DetectorNames::operator() ( const std::string &  DetectorName,
const std::string &  Detector,
const std::string &  Prefix,
const std::pair< int, int >  DataQualityBits 
)

Add new element to the table.

Parameters
[in]DetectorNameThe name of the detector as it appears in the FrDetector structure.
[in]DetectorDescription of the detector.
[in]PrefixThe channel prefix used in channel names to identify the detector used.
[in]DataQualityBitsBits used in the data quality flag by this detector.

This adds detector infomation into the set of known detectors. This routine is intended to be used by the version specific initialization routine.

◆ operator()() [2/2]

void FrameCPP::Common::DetectorNames::operator() ( const std::string &  DetectorName,
const std::string &  Detector,
const std::string &  Prefix,
const std::pair< int, int >  DataQualityBits 
)

Add new element to the table.

Parameters
[in]DetectorNameThe name of the detector as it appears in the FrDetector structure.
[in]DetectorDescription of the detector.
[in]PrefixThe channel prefix used in channel names to identify the detector used.
[in]DataQualityBitsBits used in the data quality flag by this detector.

Member Data Documentation

◆ m_frozen

bool FrameCPP::Common::DetectorNames::m_frozen
private

State variable for frozen state.

If this variable is true, then no further detectors can be appended to the list.

◆ m_info

detector_info_container_type FrameCPP::Common::DetectorNames::m_info
private

Storage for detector information.

This contains all information about detectors known at the time of the appropriate frame specification.


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