ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrDetector Class Reference

Detector data. More...

#include <FrDetector.hh>

Inheritance diagram for FrameCPP::Version_9::FrDetector:
Collaboration diagram for FrameCPP::Version_9::FrDetector:

Public Types

typedef boost::shared_ptr< FrDetectorFrDetectorCache_element
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef ObjectWithChecksum< Common::FrDetector, checksum_type > self_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 
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 aux_type::iterator aux_iterator
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
 
typedef table_type::iterator table_iterator
 
typedef table_type::const_iterator const_table_iterator
 
typedef std::string name_type
 
typedef char * prefix_type
 
typedef FR_DETECTOR_LONGITUDE_TYPE longitude_type
 
typedef FR_DETECTOR_LATITUDE_TYPE latitude_type
 
typedef FR_DETECTOR_ELEVATION_TYPE elevation_type
 
typedef FR_DETECTOR_ARM_X_AZIMUTH_TYPE armXazimuth_type
 
typedef FR_DETECTOR_ARM_Y_AZIMUTH_TYPE armYazimuth_type
 
typedef FR_DETECTOR_ARM_X_ALTITUDE_TYPE armXaltitude_type
 
typedef FR_DETECTOR_ARM_Y_ALTITUDE_TYPE armYaltitude_type
 
typedef FR_DETECTOR_ARM_X_MIDPOINT_TYPE armXmidpoint_type
 
typedef FR_DETECTOR_ARM_Y_MIDPOINT_TYPE armYmidpoint_type
 
typedef FR_DETECTOR_DATA_QUALITY_OFFSET_TYPE dataQualityOffset_type
 

Public Member Functions

 FrDetector ()
 Default constructor.
 
 FrDetector (const name_type &Name, const char *Prefix, const longitude_type Longitude, const latitude_type Latitude, const elevation_type Elevation, const armXazimuth_type ArmXazimuth, const armYazimuth_type ArmYazimuth, const armXaltitude_type ArmXaltitude, const armYaltitude_type ArmYaltitude, const armXmidpoint_type ArmXmidpoint, const armYmidpoint_type ArmYmidpoint, const dataQualityOffset_type DataQualityOffset=DQO_UNSET)
 Constructor.
 
 FrDetector (const FrDetector &detector)
 Copy constructor.
 
const std::string & GetName () const
 
 FrDetector (Previous::FrDetector &Source, stream_base_type *Stream)
 Promotion Constructor.
 
FrDetectorMerge (const FrDetector &RHS)
 Merge with another FrDetector.
 
bool operator== (const FrDetector &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
 FrDetector ()
 Default constructor.
 
 FrDetector (const name_type &Name, const char *Prefix, const longitude_type Longitude, const latitude_type Latitude, const elevation_type Elevation, const armXazimuth_type ArmXazimuth, const armYazimuth_type ArmYazimuth, const armXaltitude_type ArmXaltitude, const armYaltitude_type ArmYaltitude, const armXmidpoint_type ArmXmidpoint, const armYmidpoint_type ArmYmidpoint, const dataQualityOffset_type DataQualityOffset=DQO_UNSET)
 Constructor.
 
 FrDetector (const FrDetector &detector)
 Copy constructor.
 
const std::string & GetName () const
 
 FrDetector (Previous::FrDetector &Source, stream_base_type *Stream)
 Promotion Constructor.
 
FrDetectorMerge (const FrDetector &RHS)
 Merge with another FrDetector.
 
bool operator== (const FrDetector &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
frame_spec_version_type FrameSpecVersion () const
 
frame_spec_version_type FrameSpecVersion () const
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
const std::string & GetNameSlow () const
 Retrieve the name of the instrument.
 
const CHAR * GetPrefix () const
 Retrieve the prefix of the instrument.
 
longitude_type GetLongitude () const
 Retrieve the longitude 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.
 
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.
 
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.
 
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.
 
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 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
 

Static Public Member Functions

static FrDetectorCache_element GetDetector (FrDetector::dataQualityOffsets Offset)
 Retrieve detector information for static detectors.
 
static FrDetectorCache_element GetDetector (const std::string &Name)
 Retrieve detector information for static detectors.
 
static FrDetectorCache_element GetDetector (FrDetector::dataQualityOffsets Offset)
 Retrieve detector information for static detectors.
 
static FrDetectorCache_element GetDetector (const std::string &Name)
 Retrieve detector information for static detectors.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 
template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
static const CHAR * GetPrefix (const dataQualityOffset_type DataQualityOffset)
 
static dataQualityOffsets GetDataQualityOffset (const std::string &Name)
 

Static Public Attributes

static const FrameSpec::Info::frame_object_types STRUCT_ID
 
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
 

Protected Types

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

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 The data structure description.
 
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 The data structure description.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Static Protected Member Functions

static DMS convertCoordinate (double coordinate)
 
static DMS convertCoordinate (double coordinate)
 
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 Types

typedef ObjectWithChecksum< Common::FrDetectorobject_type
 
typedef STRING io_name_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type > object_base_type
 

Private Member Functions

 FrDetector (istream_type &Stream)
 
 FrDetector (istream_type &Stream)
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
void load (Archive &archiver, const unsigned int version)
 
void load (Archive &archiver, const unsigned int version)
 
void save (Archive &archiver, const unsigned int version) const
 
void save (Archive &archiver, const unsigned int version) const
 

Private Attributes

checksum_type m_chkSum
 Structure checksum.
 
const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 
const frame_spec_version_type frame_spec_version
 Version of the frame specification.
 

Detailed Description

Detector data.

Member Typedef Documentation

◆ armXaltitude_type

◆ armXazimuth_type

◆ armXmidpoint_type

◆ armYaltitude_type

◆ armYazimuth_type

◆ armYmidpoint_type

◆ aux_iterator

◆ aux_type

◆ const_aux_iterator

◆ const_table_iterator

◆ dataQualityOffset_type

◆ demote_arg_type

◆ demote_ret_type

◆ demote_stream_type

◆ elevation_type

◆ frame_spec_version_type

◆ FrDetectorCache_element

typedef boost::shared_ptr< FrDetector > FrameCPP::Version_9::FrDetector::FrDetectorCache_element

◆ io_name_type

typedef STRING FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::io_name_type
privateinherited

◆ istream_type

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::istream_type
inherited

◆ latitude_type

◆ longitude_type

◆ name_map_type

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

◆ name_type

◆ object_base_type

◆ object_type

typedef ObjectWithChecksum< Common::FrDetector > FrameCPP::Version_9::FrDetector::object_type
private

◆ ostream_type

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::ostream_type
inherited

◆ prefix_map_type

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

◆ prefix_type

◆ promote_arg_type

◆ promote_ret_type

◆ promote_stream_type

◆ self_type

typedef ObjectWithChecksum< Common::FrDetector, checksum_type > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::self_type
inherited

◆ string_2_type

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ table_iterator

◆ table_type

◆ unique_object_type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ dataQualityOffsets

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

◆ FrDetector() [1/10]

FrameCPP::Version_9::FrDetector::FrDetector ( )

Default constructor.

Returns
A new instance of an FrDetector object

◆ FrDetector() [2/10]

FrameCPP::Version_9::FrDetector::FrDetector ( const name_type & Name,
const char * Prefix,
const longitude_type Longitude,
const latitude_type Latitude,
const elevation_type Elevation,
const armXazimuth_type ArmXazimuth,
const armYazimuth_type ArmYazimuth,
const armXaltitude_type ArmXaltitude,
const armYaltitude_type ArmYaltitude,
const armXmidpoint_type ArmXmidpoint,
const armYmidpoint_type ArmYmidpoint,
const dataQualityOffset_type DataQualityOffset = DQO_UNSET )

Constructor.

Parameters
[in]NameInstrument name
[in]PrefixChannel prefix for this detector
[in]LongitudeDetector vertex longitude
[in]LatitudeDetector vertex latitutde.
[in]ElevationVertex elevation.
[in]ArmXazimuthOrientation of X arm.
[in]ArmYazimuthOrientation of Y arm.
[in]ArmXaltitudeAltidue angle of X arm.
[in]ArmYaltitudeAltidue angle of Y arm.
[in]ArmXmidpointDistance between the detector vertex and the middle of the X cavity.
[in]ArmYmidpointDistance between the detector vertex and the middle of the Y cavity.
Returns
A new instance of an FrDetector object

◆ FrDetector() [3/10]

FrameCPP::Version_9::FrDetector::FrDetector ( const FrDetector & detector)

Copy constructor.

Parameters
[in]detectorThe source instance to copy
Returns
A new instance of an FrDetector object

◆ FrDetector() [4/10]

FrameCPP::Version_9::FrDetector::FrDetector ( Previous::FrDetector & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrDetector structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrDetector structure was read.
Returns
A new instance of an FrDetector object

◆ FrDetector() [5/10]

FrameCPP::Version_9::FrDetector::FrDetector ( istream_type & Stream)
private

◆ FrDetector() [6/10]

FrameCPP::Version_9::FrDetector::FrDetector ( )

Default constructor.

Returns
A new instance of an FrDetector object

◆ FrDetector() [7/10]

FrameCPP::Version_9::FrDetector::FrDetector ( const name_type & Name,
const char * Prefix,
const longitude_type Longitude,
const latitude_type Latitude,
const elevation_type Elevation,
const armXazimuth_type ArmXazimuth,
const armYazimuth_type ArmYazimuth,
const armXaltitude_type ArmXaltitude,
const armYaltitude_type ArmYaltitude,
const armXmidpoint_type ArmXmidpoint,
const armYmidpoint_type ArmYmidpoint,
const dataQualityOffset_type DataQualityOffset = DQO_UNSET )

Constructor.

Parameters
[in]NameInstrument name
[in]PrefixChannel prefix for this detector
[in]LongitudeDetector vertex longitude
[in]LatitudeDetector vertex latitutde.
[in]ElevationVertex elevation.
[in]ArmXazimuthOrientation of X arm.
[in]ArmYazimuthOrientation of Y arm.
[in]ArmXaltitudeAltidue angle of X arm.
[in]ArmYaltitudeAltidue angle of Y arm.
[in]ArmXmidpointDistance between the detector vertex and the middle of the X cavity.
[in]ArmYmidpointDistance between the detector vertex and the middle of the Y cavity.
Returns
A new instance of an FrDetector object

◆ FrDetector() [8/10]

FrameCPP::Version_9::FrDetector::FrDetector ( const FrDetector & detector)

Copy constructor.

Parameters
[in]detectorThe source instance to copy
Returns
A new instance of an FrDetector object

◆ FrDetector() [9/10]

FrameCPP::Version_9::FrDetector::FrDetector ( Previous::FrDetector & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrDetector structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrDetector structure was read.
Returns
A new instance of an FrDetector object

◆ FrDetector() [10/10]

FrameCPP::Version_9::FrDetector::FrDetector ( istream_type & Stream)
private

Member Function Documentation

◆ Bytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Bytes() [2/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ CheckSumDataClass() [1/2]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Clone() [1/2]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Clone() [2/2]

virtual Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ convertCoordinate() [1/2]

static DMS FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::convertCoordinate ( double coordinate)
inlinestaticprotectedinherited

◆ convertCoordinate() [2/2]

static DMS FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::convertCoordinate ( double coordinate)
inlinestaticprotectedinherited

◆ Create() [1/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [4/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [5/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [6/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DataType() [1/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [2/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [3/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ DataType() [4/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ demote() [1/2]

virtual demote_ret_type FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inlineinherited

◆ FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inherited

◆ GetArmXaltitude()

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()

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()

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()

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()

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()

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.

◆ GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDataQualityOffset() [1/2]

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/2]

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

◆ GetDescription() [1/3]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [2/3]

virtual const Common::Description * FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::GetDescription ( ostream_type & Stream) const
inlineprotectedvirtualinherited

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

Reimplemented from FrameCPP::Common::FrameSpec::Object.

◆ GetDescription() [3/3]

virtual const Common::Description * FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::GetDescription ( ostream_type & Stream) const
inlineprotectedvirtualinherited

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

Reimplemented from FrameCPP::Common::FrameSpec::Object.

◆ GetDetector() [1/4]

static FrDetectorCache_element FrameCPP::Version_9::FrDetector::GetDetector ( const std::string & Name)
inlinestatic

Retrieve detector information for static detectors.

Parameters
[in]NameReference the detector by its name
Returns
An instance of an FrDetector object

◆ GetDetector() [2/4]

static FrDetectorCache_element FrameCPP::Version_9::FrDetector::GetDetector ( const std::string & Name)
inlinestatic

Retrieve detector information for static detectors.

Parameters
[in]NameReference the detector by its name
Returns
An instance of an FrDetector object

◆ GetDetector() [3/4]

static FrDetectorCache_element FrameCPP::Version_9::FrDetector::GetDetector ( FrDetector::dataQualityOffsets Offset)
static

Retrieve detector information for static detectors.

Parameters
[in]OffsetReference the detector by its dataQualityOffset
Returns
An instance of an FrDetector object

◆ GetDetector() [4/4]

static FrDetectorCache_element FrameCPP::Version_9::FrDetector::GetDetector ( FrDetector::dataQualityOffsets Offset)
static

Retrieve detector information for static detectors.

Parameters
[in]OffsetReference the detector by its dataQualityOffset
Returns
An instance of an FrDetector object

◆ GetElevation()

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()

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()

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::FrDetector::GetName ( ) const

◆ GetName() [2/2]

const std::string & FrameCPP::Version_9::FrDetector::GetName ( ) const

◆ GetNameSlow()

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/2]

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

Retrieve the prefix of the instrument.

Returns
The prefix for the instrument.

◆ GetPrefix() [2/2]

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]

void FrameCPP::Version_9::FrDetectorImpl::SerialIO< FrDetector >::load ( Archive & archiver,
const unsigned int version )
inlineprivateinherited

◆ load() [2/2]

void FrameCPP::Version_9::FrDetectorImpl::SerialIO< FrDetector >::load ( Archive & archiver,
const unsigned int version )
inlineprivateinherited

◆ Merge() [1/2]

FrDetector & FrameCPP::Version_9::FrDetector::Merge ( const FrDetector & RHS)

Merge with another FrDetector.

Parameters
[in]RHSThe source of the information to append to this FrDetector structure.
Returns
A reference to this object
Todo
Need to implement Merge routine

◆ Merge() [2/2]

FrDetector & FrameCPP::Version_9::FrDetector::Merge ( const FrDetector & RHS)

Merge with another FrDetector.

Parameters
[in]RHSThe source of the information to append to this FrDetector structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

virtual const char * FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::ObjectStructName ( ) const
inlineprotectedvirtualinherited

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::ObjectStructName ( ) const
inlineprotectedvirtualinherited

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [1/5]

bool FrameCPP::Version_9::FrDetector::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [2/5]

virtual bool FrameCPP::Version_9::FrDetector::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [3/5]

bool FrameCPP::Version_9::FrDetector::operator== ( const FrDetector & RHS) const
inline

equality operator

Parameters
[in]RHSThe FrDetector object to be compared.
Returns
The value true is returned if the object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/5]

bool FrameCPP::Version_9::FrDetector::operator== ( const FrDetector & RHS) const

equality operator

Parameters
[in]RHSThe FrDetector object to be compared.
Returns
The value true is returned if the object is equivelent to the RHS instance; false otherwise.

◆ operator==() [5/5]

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

◆ pBytes() [1/2]

cmn_streamsize_type FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >.

◆ pCreate() [1/2]

virtual self_type * FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

◆ pCreate() [2/2]

virtual self_type * FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

◆ prefix_equal()

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

◆ Promote() [1/2]

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

virtual promote_ret_type FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/5]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/5]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/5]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/5]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [5/5]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type Target,
FrameSpec::ObjectInterface::frame_spec_version_type Source,
FrameSpec::ObjectInterface::promote_arg_type Obj,
promote_stream_type * Stream )
inherited

◆ pWrite() [1/2]

virtual void FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >.

◆ pWrite() [2/2]

virtual void FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >.

◆ RefAux() [1/2]

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/2]

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/2]

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/2]

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]

void FrameCPP::Version_9::FrDetectorImpl::SerialIO< FrDetector >::save ( Archive & archiver,
const unsigned int version ) const
inlineprivateinherited

◆ save() [2/2]

void FrameCPP::Version_9::FrDetectorImpl::SerialIO< FrDetector >::save ( Archive & archiver,
const unsigned int version ) const
inlineprivateinherited

◆ StructDescription() [1/2]

static const Common::Description * FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inherited

◆ VerifyObject() [1/2]

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify & Verifier,
IFrameStream & Stream ) const
virtualinherited

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ VerifyObject() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify & Verifier,
IFrameStream & Stream ) const
virtualinherited

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ vTOCQuery() [1/2]

virtual void FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Write() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext() [1/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

◆ WriteNext() [2/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

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.

◆ frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version
privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

◆ 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)

◆ m_chkSum

checksum_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ 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_ID

static const FrameSpec::Info::frame_object_types FrameCPP::Common::FrDetector::STRUCT_ID
staticinherited
Initial value:

◆ 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: