ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrDetectorImpl::SerialIO< FR_DETECTOR_T > Class Template Reference

#include <FrDetectorSerialIO.hh>

Inheritance diagram for FrameCPP::Version_9::FrDetectorImpl::SerialIO< FR_DETECTOR_T >:
Collaboration diagram for FrameCPP::Version_9::FrDetectorImpl::SerialIO< FR_DETECTOR_T >:

Public Types

enum  dataQualityOffsets {
  DQO_TAMA_300 = 0 , DQO_VIRGO = 4 , DQO_GEO_600 = 6 , DQO_LHO_4K = 10 ,
  DQO_LLO_4K = 12 , DQO_CIT_40 = 14 , DQO_ACIGA = 26 , DQO_KAGRA = 28 ,
  DQO_LIGO_INDIA = 30 , DQO_DYNAMIC_01 = 2 , DQO_DYNAMIC_02 = 8 , DQO_DYNAMIC_03 = 16 ,
  DQO_DYNAMIC_04 = 18 , DQO_DYNAMIC_05 = 20 , DQO_DYNAMIC_06 = 22 , DQO_DYNAMIC_07 = 24 ,
  DQO_UNSET = 32 , DQO_CALTECH_40_METERS = DQO_CIT_40 , DQO_TAMA_300 = 0 , DQO_VIRGO = 4 ,
  DQO_GEO_600 = 6 , DQO_LHO_4K = 10 , DQO_LLO_4K = 12 , DQO_CIT_40 = 14 ,
  DQO_ACIGA = 26 , DQO_KAGRA = 28 , DQO_LIGO_INDIA = 30 , DQO_DYNAMIC_01 = 2 ,
  DQO_DYNAMIC_02 = 8 , DQO_DYNAMIC_03 = 16 , DQO_DYNAMIC_04 = 18 , DQO_DYNAMIC_05 = 20 ,
  DQO_DYNAMIC_06 = 22 , DQO_DYNAMIC_07 = 24 , DQO_UNSET = 32 , DQO_CALTECH_40_METERS = DQO_CIT_40
}
 
enum  dataQualityOffsets {
  DQO_TAMA_300 = 0 , DQO_VIRGO = 4 , DQO_GEO_600 = 6 , DQO_LHO_4K = 10 ,
  DQO_LLO_4K = 12 , DQO_CIT_40 = 14 , DQO_ACIGA = 26 , DQO_KAGRA = 28 ,
  DQO_LIGO_INDIA = 30 , DQO_DYNAMIC_01 = 2 , DQO_DYNAMIC_02 = 8 , DQO_DYNAMIC_03 = 16 ,
  DQO_DYNAMIC_04 = 18 , DQO_DYNAMIC_05 = 20 , DQO_DYNAMIC_06 = 22 , DQO_DYNAMIC_07 = 24 ,
  DQO_UNSET = 32 , DQO_CALTECH_40_METERS = DQO_CIT_40 , DQO_TAMA_300 = 0 , DQO_VIRGO = 4 ,
  DQO_GEO_600 = 6 , DQO_LHO_4K = 10 , DQO_LLO_4K = 12 , DQO_CIT_40 = 14 ,
  DQO_ACIGA = 26 , DQO_KAGRA = 28 , DQO_LIGO_INDIA = 30 , DQO_DYNAMIC_01 = 2 ,
  DQO_DYNAMIC_02 = 8 , DQO_DYNAMIC_03 = 16 , DQO_DYNAMIC_04 = 18 , DQO_DYNAMIC_05 = 20 ,
  DQO_DYNAMIC_06 = 22 , DQO_DYNAMIC_07 = 24 , DQO_UNSET = 32 , DQO_CALTECH_40_METERS = DQO_CIT_40
}
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > aux_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > aux_type
 
typedef aux_type::iterator aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
 
typedef table_type::iterator table_iterator
 
typedef table_type::iterator table_iterator
 
typedef table_type::const_iterator const_table_iterator
 
typedef table_type::const_iterator const_table_iterator
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef char * prefix_type
 
typedef char * prefix_type
 
typedef FR_DETECTOR_LONGITUDE_TYPE longitude_type
 
typedef FR_DETECTOR_LONGITUDE_TYPE longitude_type
 
typedef FR_DETECTOR_LATITUDE_TYPE latitude_type
 
typedef FR_DETECTOR_LATITUDE_TYPE latitude_type
 
typedef FR_DETECTOR_ELEVATION_TYPE elevation_type
 
typedef FR_DETECTOR_ELEVATION_TYPE elevation_type
 
typedef FR_DETECTOR_ARM_X_AZIMUTH_TYPE armXazimuth_type
 
typedef FR_DETECTOR_ARM_X_AZIMUTH_TYPE armXazimuth_type
 
typedef FR_DETECTOR_ARM_Y_AZIMUTH_TYPE armYazimuth_type
 
typedef FR_DETECTOR_ARM_Y_AZIMUTH_TYPE armYazimuth_type
 
typedef FR_DETECTOR_ARM_X_ALTITUDE_TYPE armXaltitude_type
 
typedef FR_DETECTOR_ARM_X_ALTITUDE_TYPE armXaltitude_type
 
typedef FR_DETECTOR_ARM_Y_ALTITUDE_TYPE armYaltitude_type
 
typedef FR_DETECTOR_ARM_Y_ALTITUDE_TYPE armYaltitude_type
 
typedef FR_DETECTOR_ARM_X_MIDPOINT_TYPE armXmidpoint_type
 
typedef FR_DETECTOR_ARM_X_MIDPOINT_TYPE armXmidpoint_type
 
typedef FR_DETECTOR_ARM_Y_MIDPOINT_TYPE armYmidpoint_type
 
typedef FR_DETECTOR_ARM_Y_MIDPOINT_TYPE armYmidpoint_type
 
typedef FR_DETECTOR_DATA_QUALITY_OFFSET_TYPE dataQualityOffset_type
 
typedef FR_DETECTOR_DATA_QUALITY_OFFSET_TYPE dataQualityOffset_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 

Public Member Functions

 SerialIO ()
 
 SerialIO ()
 
const std::string & GetName () const
 Retrieve the name of the instrument.
 
const std::string & GetName () const
 Retrieve the name of the instrument.
 
const std::string & GetNameSlow () const
 Retrieve the name of the instrument.
 
const std::string & GetNameSlow () const
 Retrieve the name of the instrument.
 
const CHAR * GetPrefix () const
 Retrieve the prefix of the instrument.
 
const CHAR * GetPrefix () const
 Retrieve the prefix of the instrument.
 
longitude_type GetLongitude () const
 Retrieve the longitude of the detector vertex.
 
longitude_type GetLongitude () const
 Retrieve the longitude of the detector vertex.
 
latitude_type GetLatitude () const
 Retrieve the latitude of the detector vertex.
 
latitude_type GetLatitude () const
 Retrieve the latitude of the detector vertex.
 
elevation_type GetElevation () const
 Retrieve the vertex elevation of the detector.
 
elevation_type GetElevation () const
 Retrieve the vertex elevation of the detector.
 
armXazimuth_type GetArmXazimuth () const
 Retrieve the orientation of X arm of the detector.
 
armXazimuth_type GetArmXazimuth () const
 Retrieve the orientation of X arm of the detector.
 
armYazimuth_type GetArmYazimuth () const
 Retrieve the orientation of Y arm of the detector.
 
armYazimuth_type GetArmYazimuth () const
 Retrieve the orientation of Y arm of the detector.
 
armXaltitude_type GetArmXaltitude () const
 Retrieve the altitude angle of X arm of the detector.
 
armXaltitude_type GetArmXaltitude () const
 Retrieve the altitude angle of X arm of the detector.
 
armYaltitude_type GetArmYaltitude () const
 Retrieve the altitude angle of Y arm of the detector.
 
armYaltitude_type GetArmYaltitude () const
 Retrieve the altitude angle of Y arm of the detector.
 
armXmidpoint_type GetArmXmidpoint () const
 Retrieve the midpoint of the X arm of the detector.
 
armXmidpoint_type GetArmXmidpoint () const
 Retrieve the midpoint of the X arm of the detector.
 
armYmidpoint_type GetArmYmidpoint () const
 Retrieve the midpoint of the Y arm of the detector.
 
armYmidpoint_type GetArmYmidpoint () const
 Retrieve the midpoint of the Y arm of the detector.
 
dataQualityOffset_type GetDataQualityOffset () const
 Bit offset of the low order bit of the data quality mask.
 
dataQualityOffset_type GetDataQualityOffset () const
 Bit offset of the low order bit of the data quality mask.
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information.
 
aux_typeRefAux ()
 Identifier for vector for user-provided information.
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information.
 
aux_typeRefAux ()
 Identifier for vector for user-provided information.
 
const table_typeRefTable () const
 Identifier for user-provided information in table format.
 
table_typeRefTable ()
 Identifier for user-provided information in table format.
 
const table_typeRefTable () const
 Identifier for user-provided information in table format.
 
table_typeRefTable ()
 Identifier for user-provided information in table format.
 
bool operator== (Data const &RHS) const
 
bool operator== (Data const &RHS) const
 

Static Public Member Functions

static const CHAR * GetPrefix (const dataQualityOffset_type DataQualityOffset)
 
static const CHAR * GetPrefix (const dataQualityOffset_type DataQualityOffset)
 
static dataQualityOffsets GetDataQualityOffset (const std::string &Name)
 
static dataQualityOffsets GetDataQualityOffset (const std::string &Name)
 
static struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 

Static Public Attributes

static constexpr char TAMA_300_PREFIX [2] = { 'T', '1' }
 
static constexpr char VIRGO_PREFIX [2] = { 'V', '1' }
 
static constexpr char GEO_600_PREFIX [2] = { 'G', '1' }
 
static constexpr char LHO_4K_PREFIX [2] = { 'H', '1' }
 
static constexpr char LLO_4K_PREFIX [2] = { 'L', '1' }
 
static constexpr char CIT_40_PREFIX [2] = { 'C', '1' }
 
static constexpr char ACIGA_PREFIX [2] = { 'U', '1' }
 
static constexpr char KAGRA_PREFIX [2] = { 'K', '1' }
 
static constexpr char LIGO_INDIA_PREFIX [2] = { 'A', '1' }
 
static constexpr char UNKNOWN_PREFIX [2] = { ' ', ' ' }
 
static std::map< char[2], int > prefix_mapping
 
static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

Protected Types

typedef boost::bimap< std::string, dataQualityOffsetsname_map_type
 
typedef boost::bimap< std::string, dataQualityOffsetsname_map_type
 
typedef boost::bimap< std::string, dataQualityOffsetsprefix_map_type
 
typedef boost::bimap< std::string, dataQualityOffsetsprefix_map_type
 

Static Protected Member Functions

static bool prefix_equal (const char *RHS, const char *LHS)
 
static bool prefix_equal (const char *RHS, const char *LHS)
 

Protected Attributes

name_type name
 
CHAR prefix [2] = { ' ', ' ' }
 Channel prefix for this detector as described here.
 
longitude_type longitude
 
latitude_type latitude
 
elevation_type elevation
 
armXazimuth_type armXazimuth
 
armYazimuth_type armYazimuth
 
armXaltitude_type armXaltitude
 
armYaltitude_type armYaltitude
 
armXmidpoint_type armXmidpoint
 
armYmidpoint_type armYmidpoint
 
dataQualityOffset_type dataQualityOffset = DQO_UNSET
 
aux_type aux
 
table_type table
 

Static Protected Attributes

static const constexpr INT_2U MAX_REF = 2
 
static name_map_type name_map
 
static prefix_map_type prefix_map
 

Private Member Functions

template<class Archive>
void load (Archive &archiver, const unsigned int version)
 
template<class Archive>
void save (Archive &archiver, const unsigned int version) const
 
template<class Archive>
void load (Archive &archiver, const unsigned int version)
 
template<class Archive>
void save (Archive &archiver, const unsigned int version) const
 

Friends

class boost::serialization::access
 

Member Typedef Documentation

◆ armXaltitude_type [1/2]

◆ armXaltitude_type [2/2]

◆ armXazimuth_type [1/2]

◆ armXazimuth_type [2/2]

◆ armXmidpoint_type [1/2]

◆ armXmidpoint_type [2/2]

◆ armYaltitude_type [1/2]

◆ armYaltitude_type [2/2]

◆ armYazimuth_type [1/2]

◆ armYazimuth_type [2/2]

◆ armYmidpoint_type [1/2]

◆ armYmidpoint_type [2/2]

◆ aux_iterator [1/2]

◆ aux_iterator [2/2]

◆ aux_type [1/2]

◆ aux_type [2/2]

◆ const_aux_iterator [1/2]

◆ const_aux_iterator [2/2]

◆ const_table_iterator [1/2]

◆ const_table_iterator [2/2]

◆ dataQualityOffset_type [1/2]

◆ dataQualityOffset_type [2/2]

◆ elevation_type [1/2]

◆ elevation_type [2/2]

◆ latitude_type [1/2]

◆ latitude_type [2/2]

◆ longitude_type [1/2]

◆ longitude_type [2/2]

◆ name_map_type [1/2]

typedef boost::bimap< std::string, dataQualityOffsets > FrameCPP::Version_9::FrDetectorImpl::Data::name_map_type
protectedinherited

◆ name_map_type [2/2]

typedef boost::bimap< std::string, dataQualityOffsets > FrameCPP::Version_9::FrDetectorImpl::Data::name_map_type
protectedinherited

◆ name_type [1/2]

◆ name_type [2/2]

◆ prefix_map_type [1/2]

typedef boost::bimap< std::string, dataQualityOffsets > FrameCPP::Version_9::FrDetectorImpl::Data::prefix_map_type
protectedinherited

◆ prefix_map_type [2/2]

typedef boost::bimap< std::string, dataQualityOffsets > FrameCPP::Version_9::FrDetectorImpl::Data::prefix_map_type
protectedinherited

◆ prefix_type [1/2]

◆ prefix_type [2/2]

◆ struct_desc_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_desc_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type [1/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_id_type [2/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ struct_name_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ table_iterator [1/2]

◆ table_iterator [2/2]

◆ table_type [1/2]

◆ table_type [2/2]

Member Enumeration Documentation

◆ dataQualityOffsets [1/2]

Enumerator
DQO_TAMA_300 

TAMA 300.

DQO_VIRGO 

Virgo 3 km.

DQO_GEO_600 

GEO 600.

DQO_LHO_4K 

LIGO LHO 4 km.

DQO_LLO_4K 

LIGO LLO 4 km.

DQO_CIT_40 

Caltech 40 meters.

DQO_ACIGA 

ACIGA.

DQO_KAGRA 

KAGRA.

DQO_LIGO_INDIA 

LIGO India.

DQO_DYNAMIC_01 
DQO_DYNAMIC_02 
DQO_DYNAMIC_03 
DQO_DYNAMIC_04 
DQO_DYNAMIC_05 
DQO_DYNAMIC_06 
DQO_DYNAMIC_07 
DQO_UNSET 
DQO_CALTECH_40_METERS 

Caltech 40 meters.

DQO_TAMA_300 

TAMA 300.

DQO_VIRGO 

Virgo 3 km.

DQO_GEO_600 

GEO 600.

DQO_LHO_4K 

LIGO LHO 4 km.

DQO_LLO_4K 

LIGO LLO 4 km.

DQO_CIT_40 

Caltech 40 meters.

DQO_ACIGA 

ACIGA.

DQO_KAGRA 

KAGRA.

DQO_LIGO_INDIA 

LIGO India.

DQO_DYNAMIC_01 
DQO_DYNAMIC_02 
DQO_DYNAMIC_03 
DQO_DYNAMIC_04 
DQO_DYNAMIC_05 
DQO_DYNAMIC_06 
DQO_DYNAMIC_07 
DQO_UNSET 
DQO_CALTECH_40_METERS 

Caltech 40 meters.

◆ dataQualityOffsets [2/2]

Enumerator
DQO_TAMA_300 

TAMA 300.

DQO_VIRGO 

Virgo 3 km.

DQO_GEO_600 

GEO 600.

DQO_LHO_4K 

LIGO LHO 4 km.

DQO_LLO_4K 

LIGO LLO 4 km.

DQO_CIT_40 

Caltech 40 meters.

DQO_ACIGA 

ACIGA.

DQO_KAGRA 

KAGRA.

DQO_LIGO_INDIA 

LIGO India.

DQO_DYNAMIC_01 
DQO_DYNAMIC_02 
DQO_DYNAMIC_03 
DQO_DYNAMIC_04 
DQO_DYNAMIC_05 
DQO_DYNAMIC_06 
DQO_DYNAMIC_07 
DQO_UNSET 
DQO_CALTECH_40_METERS 

Caltech 40 meters.

DQO_TAMA_300 

TAMA 300.

DQO_VIRGO 

Virgo 3 km.

DQO_GEO_600 

GEO 600.

DQO_LHO_4K 

LIGO LHO 4 km.

DQO_LLO_4K 

LIGO LLO 4 km.

DQO_CIT_40 

Caltech 40 meters.

DQO_ACIGA 

ACIGA.

DQO_KAGRA 

KAGRA.

DQO_LIGO_INDIA 

LIGO India.

DQO_DYNAMIC_01 
DQO_DYNAMIC_02 
DQO_DYNAMIC_03 
DQO_DYNAMIC_04 
DQO_DYNAMIC_05 
DQO_DYNAMIC_06 
DQO_DYNAMIC_07 
DQO_UNSET 
DQO_CALTECH_40_METERS 

Caltech 40 meters.

Constructor & Destructor Documentation

◆ SerialIO() [1/2]

template<typename FR_DETECTOR_T>
FrameCPP::Version_9::FrDetectorImpl::SerialIO< FR_DETECTOR_T >::SerialIO ( )
inline

◆ SerialIO() [2/2]

template<typename FR_DETECTOR_T>
FrameCPP::Version_9::FrDetectorImpl::SerialIO< FR_DETECTOR_T >::SerialIO ( )
inline

Member Function Documentation

◆ FrameSpecDescription() [1/2]

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/2]

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/2]

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/2]

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/2]

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/2]

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetArmXaltitude() [1/2]

armXaltitude_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmXaltitude ( ) const
inlineinherited

Retrieve the altitude angle of X arm of the detector.

Returns
The altitude angle of the X arm of the detector.

◆ GetArmXaltitude() [2/2]

armXaltitude_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmXaltitude ( ) const
inlineinherited

Retrieve the altitude angle of X arm of the detector.

Returns
The altitude angle of the X arm of the detector.

◆ GetArmXazimuth() [1/2]

armXazimuth_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmXazimuth ( ) const
inlineinherited

Retrieve the orientation of X arm of the detector.

Returns
The orientation of the X arm of the detector.

◆ GetArmXazimuth() [2/2]

armXazimuth_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmXazimuth ( ) const
inlineinherited

Retrieve the orientation of X arm of the detector.

Returns
The orientation of the X arm of the detector.

◆ GetArmXmidpoint() [1/2]

armXmidpoint_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmXmidpoint ( ) const
inlineinherited

Retrieve the midpoint of the X arm of the detector.

Returns
The midpoint of the X arm of the detector.

◆ GetArmXmidpoint() [2/2]

armXmidpoint_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmXmidpoint ( ) const
inlineinherited

Retrieve the midpoint of the X arm of the detector.

Returns
The midpoint of the X arm of the detector.

◆ GetArmYaltitude() [1/2]

armYaltitude_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmYaltitude ( ) const
inlineinherited

Retrieve the altitude angle of Y arm of the detector.

Returns
The altitude angle of the Y arm of the detector.

◆ GetArmYaltitude() [2/2]

armYaltitude_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmYaltitude ( ) const
inlineinherited

Retrieve the altitude angle of Y arm of the detector.

Returns
The altitude angle of the Y arm of the detector.

◆ GetArmYazimuth() [1/2]

armYazimuth_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmYazimuth ( ) const
inlineinherited

Retrieve the orientation of Y arm of the detector.

Returns
The orientation of the Y arm of the detector.

◆ GetArmYazimuth() [2/2]

armYazimuth_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmYazimuth ( ) const
inlineinherited

Retrieve the orientation of Y arm of the detector.

Returns
The orientation of the Y arm of the detector.

◆ GetArmYmidpoint() [1/2]

armYmidpoint_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmYmidpoint ( ) const
inlineinherited

Retrieve the midpoint of the Y arm of the detector.

Returns
The midpoint of the Y arm of the detector.

◆ GetArmYmidpoint() [2/2]

armYmidpoint_type FrameCPP::Version_9::FrDetectorImpl::Data::GetArmYmidpoint ( ) const
inlineinherited

Retrieve the midpoint of the Y arm of the detector.

Returns
The midpoint of the Y arm of the detector.

◆ GetDataQualityOffset() [1/4]

dataQualityOffset_type FrameCPP::Version_9::FrDetectorImpl::Data::GetDataQualityOffset ( ) const
inlineinherited

Bit offset of the low order bit of the data quality mask.

Returns
The bit offset.

◆ GetDataQualityOffset() [2/4]

dataQualityOffset_type FrameCPP::Version_9::FrDetectorImpl::Data::GetDataQualityOffset ( ) const
inlineinherited

Bit offset of the low order bit of the data quality mask.

Returns
The bit offset.

◆ GetDataQualityOffset() [3/4]

static dataQualityOffsets FrameCPP::Version_9::FrDetectorImpl::Data::GetDataQualityOffset ( const std::string & Name)
inlinestaticinherited

◆ GetDataQualityOffset() [4/4]

static dataQualityOffsets FrameCPP::Version_9::FrDetectorImpl::Data::GetDataQualityOffset ( const std::string & Name)
inlinestaticinherited

◆ GetElevation() [1/2]

elevation_type FrameCPP::Version_9::FrDetectorImpl::Data::GetElevation ( ) const
inlineinherited

Retrieve the vertex elevation of the detector.

Returns
The vertex elevation of the detector.

◆ GetElevation() [2/2]

elevation_type FrameCPP::Version_9::FrDetectorImpl::Data::GetElevation ( ) const
inlineinherited

Retrieve the vertex elevation of the detector.

Returns
The vertex elevation of the detector.

◆ GetLatitude() [1/2]

latitude_type FrameCPP::Version_9::FrDetectorImpl::Data::GetLatitude ( ) const
inlineinherited

Retrieve the latitude of the detector vertex.

Returns
The latitude of the detector vertex.

◆ GetLatitude() [2/2]

latitude_type FrameCPP::Version_9::FrDetectorImpl::Data::GetLatitude ( ) const
inlineinherited

Retrieve the latitude of the detector vertex.

Returns
The latitude of the detector vertex.

◆ GetLongitude() [1/2]

longitude_type FrameCPP::Version_9::FrDetectorImpl::Data::GetLongitude ( ) const
inlineinherited

Retrieve the longitude of the detector vertex.

Returns
The longitude of the detector vertex.

◆ GetLongitude() [2/2]

longitude_type FrameCPP::Version_9::FrDetectorImpl::Data::GetLongitude ( ) const
inlineinherited

Retrieve the longitude of the detector vertex.

Returns
The longitude of the detector vertex.

◆ GetName() [1/2]

const std::string & FrameCPP::Version_9::FrDetectorImpl::Data::GetName ( ) const
inlineinherited

Retrieve the name of the instrument.

Returns
The name of the instrument.

◆ GetName() [2/2]

const std::string & FrameCPP::Version_9::FrDetectorImpl::Data::GetName ( ) const
inlineinherited

Retrieve the name of the instrument.

Returns
The name of the instrument.

◆ GetNameSlow() [1/2]

const std::string & FrameCPP::Version_9::FrDetectorImpl::Data::GetNameSlow ( ) const
inlineinherited

Retrieve the name of the instrument.

Returns
The name of the instrument.

◆ GetNameSlow() [2/2]

const std::string & FrameCPP::Version_9::FrDetectorImpl::Data::GetNameSlow ( ) const
inlineinherited

Retrieve the name of the instrument.

Returns
The name of the instrument.

◆ GetPrefix() [1/4]

const CHAR * FrameCPP::Version_9::FrDetectorImpl::Data::GetPrefix ( ) const
inlineinherited

Retrieve the prefix of the instrument.

Returns
The prefix for the instrument.

◆ GetPrefix() [2/4]

const CHAR * FrameCPP::Version_9::FrDetectorImpl::Data::GetPrefix ( ) const
inlineinherited

Retrieve the prefix of the instrument.

Returns
The prefix for the instrument.

◆ GetPrefix() [3/4]

static const CHAR * FrameCPP::Version_9::FrDetectorImpl::Data::GetPrefix ( const dataQualityOffset_type DataQualityOffset)
inlinestaticinherited
Parameters
[in]DataQualityOffsetThe data quality offset of the left bit.
Returns
Prefix

◆ GetPrefix() [4/4]

static const CHAR * FrameCPP::Version_9::FrDetectorImpl::Data::GetPrefix ( const dataQualityOffset_type DataQualityOffset)
inlinestaticinherited
Parameters
[in]DataQualityOffsetThe data quality offset of the left bit.
Returns
Prefix

◆ load() [1/2]

template<typename FR_DETECTOR_T>
template<class Archive>
void FrameCPP::Version_9::FrDetectorImpl::SerialIO< FR_DETECTOR_T >::load ( Archive & archiver,
const unsigned int version )
inlineprivate

◆ load() [2/2]

template<typename FR_DETECTOR_T>
template<class Archive>
void FrameCPP::Version_9::FrDetectorImpl::SerialIO< FR_DETECTOR_T >::load ( Archive & archiver,
const unsigned int version )
inlineprivate

◆ operator==() [1/2]

bool FrameCPP::Version_9::FrDetectorImpl::Data::operator== ( Data const & RHS) const
inlineinherited

◆ operator==() [2/2]

bool FrameCPP::Version_9::FrDetectorImpl::Data::operator== ( Data const & RHS) const
inlineinherited

◆ prefix_equal() [1/2]

static bool FrameCPP::Version_9::FrDetectorImpl::Data::prefix_equal ( const char * RHS,
const char * LHS )
inlinestaticprotectedinherited

◆ prefix_equal() [2/2]

static bool FrameCPP::Version_9::FrDetectorImpl::Data::prefix_equal ( const char * RHS,
const char * LHS )
inlinestaticprotectedinherited

◆ RefAux() [1/4]

aux_type & FrameCPP::Version_9::FrDetectorImpl::Data::RefAux ( )
inlineinherited

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [2/4]

aux_type & FrameCPP::Version_9::FrDetectorImpl::Data::RefAux ( )
inlineinherited

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [3/4]

const aux_type & FrameCPP::Version_9::FrDetectorImpl::Data::RefAux ( ) const
inlineinherited

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefAux() [4/4]

const aux_type & FrameCPP::Version_9::FrDetectorImpl::Data::RefAux ( ) const
inlineinherited

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefTable() [1/4]

table_type & FrameCPP::Version_9::FrDetectorImpl::Data::RefTable ( )
inlineinherited

Identifier for user-provided information in table format.

Returns
A reference to the user-provided table information.

◆ RefTable() [2/4]

table_type & FrameCPP::Version_9::FrDetectorImpl::Data::RefTable ( )
inlineinherited

Identifier for user-provided information in table format.

Returns
A reference to the user-provided table information.

◆ RefTable() [3/4]

const table_type & FrameCPP::Version_9::FrDetectorImpl::Data::RefTable ( ) const
inlineinherited

Identifier for user-provided information in table format.

Returns
A constant reference to the user-provided table information.

◆ RefTable() [4/4]

const table_type & FrameCPP::Version_9::FrDetectorImpl::Data::RefTable ( ) const
inlineinherited

Identifier for user-provided information in table format.

Returns
A constant reference to the user-provided table information.

◆ save() [1/2]

template<typename FR_DETECTOR_T>
template<class Archive>
void FrameCPP::Version_9::FrDetectorImpl::SerialIO< FR_DETECTOR_T >::save ( Archive & archiver,
const unsigned int version ) const
inlineprivate

◆ save() [2/2]

template<typename FR_DETECTOR_T>
template<class Archive>
void FrameCPP::Version_9::FrDetectorImpl::SerialIO< FR_DETECTOR_T >::save ( Archive & archiver,
const unsigned int version ) const
inlineprivate

◆ StructName() [1/2]

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [2/2]

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<typename FR_DETECTOR_T>
boost::serialization::access
friend

Member Data Documentation

◆ ACIGA_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::ACIGA_PREFIX = { 'U', '1' }
staticconstexprinherited

◆ armXaltitude

armXaltitude_type FrameCPP::Version_9::FrDetectorImpl::Data::armXaltitude
protectedinherited

Altitude (pitch) angle to X arm, measured in radians above horizon (local tangent to WGS84 ellipsoid) -pi/2 < ArmXaltitude <= pi/2

◆ armXazimuth

armXazimuth_type FrameCPP::Version_9::FrDetectorImpl::Data::armXazimuth
protectedinherited

Orientation of X arm, measured in radians East of North (0 <= ArmXazimuth < 2pi)

◆ armXmidpoint

armXmidpoint_type FrameCPP::Version_9::FrDetectorImpl::Data::armXmidpoint
protectedinherited

Distance between the detector vertex and the middle of the X cavity (meters) (should be zero for bars).

◆ armYaltitude

armYaltitude_type FrameCPP::Version_9::FrDetectorImpl::Data::armYaltitude
protectedinherited

Altitude (pitch) angle to Y arm, measured in radians above horizon (local tangent to WGS84 ellipsoid) -pi/2 < ArmXaltitude <= pi/2

◆ armYazimuth

armYazimuth_type FrameCPP::Version_9::FrDetectorImpl::Data::armYazimuth
protectedinherited

Orientation of Y arm, measured in radians East of North (0 <= ArmYazimuth < 2pi)

◆ armYmidpoint

armYmidpoint_type FrameCPP::Version_9::FrDetectorImpl::Data::armYmidpoint
protectedinherited

Distance between the detector vertex and the middle of the Y cavity (meters) (should be zero for bars).

◆ aux

aux_type FrameCPP::Version_9::FrDetectorImpl::Data::aux
protectedinherited

Indentifier for user-provided structure for additional detector data.

◆ CIT_40_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::CIT_40_PREFIX = { 'C', '1' }
staticconstexprinherited

◆ dataQualityOffset

dataQualityOffset_type FrameCPP::Version_9::FrDetectorImpl::Data::dataQualityOffset = DQO_UNSET
protectedinherited

Data quality offset Bit offset of the low order bit of the data quality mask.

◆ elevation

elevation_type FrameCPP::Version_9::FrDetectorImpl::Data::elevation
protectedinherited

Vertex elevation, in meters, relative to WGS84 ellipsoid.

◆ GEO_600_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::GEO_600_PREFIX = { 'G', '1' }
staticconstexprinherited

◆ KAGRA_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::KAGRA_PREFIX = { 'K', '1' }
staticconstexprinherited

◆ latitude

latitude_type FrameCPP::Version_9::FrDetectorImpl::Data::latitude
protectedinherited

Detector vertex latitude, geographical coordinated: radians; Value >= 0 >= N of Equator (-pi/2 < Latitude <= +pi/2).

◆ LHO_4K_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::LHO_4K_PREFIX = { 'H', '1' }
staticconstexprinherited

◆ LIGO_INDIA_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::LIGO_INDIA_PREFIX = { 'A', '1' }
staticconstexprinherited

◆ LLO_4K_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::LLO_4K_PREFIX = { 'L', '1' }
staticconstexprinherited

◆ longitude

longitude_type FrameCPP::Version_9::FrDetectorImpl::Data::longitude
protectedinherited

Detector vertex longitude, geographical coordinates: radians; Value > 0 >= E of Greenwich (-pi < Longitude <= +pi)

◆ MAX_REF

static const constexpr INT_2U FrameCPP::Version_9::FrDetectorImpl::Data::MAX_REF = 2
staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_9::FrDetectorImpl::Data::name
protectedinherited

Instrument name as described here (e.g., Virgo; GEO_600; TAMA_300; LHO_2k; LLO_4k; 40M; PNI; simulated pseudo data - model version etc.)

◆ name_map

static name_map_type FrameCPP::Version_9::FrDetectorImpl::Data::name_map
staticprotectedinherited
Initial value:
=
make_bimap< Data::name_map_type::left_key_type,
Data::name_map_type::right_key_type >(
{ { "ACIGA", DQO_ACIGA },
{ "CIT_40", DQO_CIT_40 },
{ "GEO_600", DQO_GEO_600 },
{ "KAGRA", DQO_KAGRA },
{ "LHO_4k", DQO_LHO_4K },
{ "LIGO_India", DQO_LIGO_INDIA },
{ "LLO_4k", DQO_LLO_4K },
{ "TAMA_300", DQO_TAMA_300 },
{ "VIRGO", DQO_VIRGO } } )
boost::bimap< L, R > make_bimap(std::initializer_list< typename boost::bimap< L, R >::value_type > list)
Definition FrDetectorData.cc:5
@ DQO_ACIGA
ACIGA.
Definition FrDetectorData.hh:126
@ DQO_LHO_4K
LIGO LHO 4 km.
Definition FrDetectorData.hh:123
@ DQO_LIGO_INDIA
LIGO India.
Definition FrDetectorData.hh:128
@ DQO_GEO_600
GEO 600.
Definition FrDetectorData.hh:122
@ DQO_KAGRA
KAGRA.
Definition FrDetectorData.hh:127
@ DQO_TAMA_300
TAMA 300.
Definition FrDetectorData.hh:120
@ DQO_CIT_40
Caltech 40 meters.
Definition FrDetectorData.hh:125
@ DQO_VIRGO
Virgo 3 km.
Definition FrDetectorData.hh:121
@ DQO_LLO_4K
LIGO LLO 4 km.
Definition FrDetectorData.hh:124

◆ prefix

CHAR FrameCPP::Version_9::FrDetectorImpl::Data::prefix = { ' ', ' ' }
protectedinherited

Channel prefix for this detector as described here.

◆ prefix_map

static prefix_map_type FrameCPP::Version_9::FrDetectorImpl::Data::prefix_map
staticprotectedinherited
Initial value:
=
make_bimap< prefix_map_type::left_key_type,
prefix_map_type::right_key_type >(
{ { "A1", DQO_LIGO_INDIA },
{ "C1", DQO_CIT_40 },
{ "G1", DQO_GEO_600 },
{ "H1", DQO_LHO_4K },
{ "K1", DQO_KAGRA },
{ "L1", DQO_LLO_4K },
{ "T1", DQO_TAMA_300 },
{ "U1", DQO_ACIGA },
{ "V1", DQO_VIRGO } } )

◆ prefix_mapping

static std::map< char[2], int > FrameCPP::Version_9::FrDetectorImpl::Data::prefix_mapping
staticinherited

◆ struct_desc

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

◆ table

table_type FrameCPP::Version_9::FrDetectorImpl::Data::table
protectedinherited

Identifier fo ruser-provided table structure for additional detector data.

◆ TAMA_300_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::TAMA_300_PREFIX = { 'T', '1' }
staticconstexprinherited

◆ UNKNOWN_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::UNKNOWN_PREFIX = { ' ', ' ' }
staticconstexprinherited

◆ VIRGO_PREFIX

static constexpr char FrameCPP::Version_9::FrDetectorImpl::Data::VIRGO_PREFIX = { 'V', '1' }
staticconstexprinherited

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