Maintains information about known detectors.
More...
#include <DetectorNames.hh>
Maintains information about known detectors.
◆ detector_info_container_type [1/2]
◆ detector_info_container_type [2/2]
◆ 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 |
( |
| ) |
|
◆ Detector() [1/2]
Get information about a detector.
This method retrieves information about a detector.
- Parameters
-
[in] | Name | The name of the detector as listed in the FrDetector structure. |
- Returns
- Information associated with the detector.
- Exceptions
-
std::range_error | This 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] | Name | The name of the detector as listed in the FrDetector structure. |
- Returns
- Information associated with the detector.
◆ Freeze() [1/2]
void FrameCPP::Common::DetectorNames::Freeze |
( |
| ) |
|
Prevent any further modifications to the structure.
◆ Freeze() [2/2]
void FrameCPP::Common::DetectorNames::Freeze |
( |
| ) |
|
|
inline |
Prevent any further modifications to the structure.
Prevent further additions to the set of detectors.
◆ 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] | DetectorName | The name of the detector as it appears in the FrDetector structure. |
[in] | Detector | Description of the detector. |
[in] | Prefix | The channel prefix used in channel names to identify the detector used. |
[in] | DataQualityBits | Bits 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] | DetectorName | The name of the detector as it appears in the FrDetector structure. |
[in] | Detector | Description of the detector. |
[in] | Prefix | The channel prefix used in channel names to identify the detector used. |
[in] | DataQualityBits | Bits used in the data quality flag by this detector. |
◆ 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
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: