ldas-tools-framecpp  2.6.2
Classes | Public Member Functions | 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...
 

Detailed Description

Maintains information about known detectors.

Constructor & Destructor Documentation

◆ DetectorNames()

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

Constructor.

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

Member Function Documentation

◆ Detector()

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.

◆ Freeze()

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

Prevent any further modifications to the structure.

Prevent further additions to the set of detectors.

◆ operator()()

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.


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