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

#include <FrDetectorSerialIO.hh>

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

Public Types

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_LOCAL_TIME_TYPE localTime_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 

Public Member Functions

 SerialIO ()
 
 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.
 
localTime_type GetLocalTime () const
 Retrieve the local seasonal time.
 
localTime_type GetLocalTime () const
 Retrieve the local seasonal time.
 
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 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 struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

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
 
localTime_type localTime
 
aux_type aux
 
table_type table
 

Static Protected Attributes

static const constexpr INT_2U MAX_REF = 2
 

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

◆ armXazimuth_type

◆ armXmidpoint_type

◆ armYaltitude_type

◆ armYazimuth_type

◆ armYmidpoint_type

◆ aux_iterator

◆ aux_type

◆ const_aux_iterator

◆ const_table_iterator

◆ elevation_type

◆ latitude_type

◆ localTime_type

◆ longitude_type

◆ name_type

◆ prefix_type

◆ struct_desc_type

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

◆ struct_id_type

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

◆ struct_name_type

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

◆ table_iterator

◆ table_type

Constructor & Destructor Documentation

◆ SerialIO() [1/3]

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

◆ SerialIO() [2/3]

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

◆ SerialIO() [3/3]

template<typename FR_DETECTOR_T >
FrameCPP::Version_8::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_8::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_8::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_8::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_8::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_8::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_8::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_8::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_8::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_8::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_8::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_8::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_8::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.

◆ GetElevation() [1/2]

elevation_type FrameCPP::Version_8::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_8::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_8::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_8::FrDetectorImpl::Data::GetLatitude ( ) const
inlineinherited

Retrieve the latitude of the detector vertex.

Returns
The latitude of the detector vertex.

◆ GetLocalTime() [1/2]

localTime_type FrameCPP::Version_8::FrDetectorImpl::Data::GetLocalTime ( ) const
inlineinherited

Retrieve the local seasonal time.

Returns
The local seasonal time.

◆ GetLocalTime() [2/2]

localTime_type FrameCPP::Version_8::FrDetectorImpl::Data::GetLocalTime ( ) const
inlineinherited

Retrieve the local seasonal time.

Returns
The local seasonal time.

◆ GetLongitude() [1/2]

longitude_type FrameCPP::Version_8::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_8::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_8::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_8::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_8::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_8::FrDetectorImpl::Data::GetNameSlow ( ) const
inlineinherited

Retrieve the name of the instrument.

Returns
The name of the instrument.

◆ GetPrefix() [1/2]

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

Retrieve the prefix of the instrument.

Returns
The prefix for the instrument.

◆ GetPrefix() [2/2]

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

Retrieve the prefix of the instrument.

Returns
The prefix for the instrument.

◆ load() [1/3]

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

◆ load() [2/3]

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

◆ load() [3/3]

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

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

◆ RefAux() [1/4]

aux_type & FrameCPP::Version_8::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_8::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_8::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_8::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_8::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_8::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_8::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_8::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/3]

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

◆ save() [2/3]

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

◆ save() [3/3]

template<typename FR_DETECTOR_T >
template<class Archive >
void FrameCPP::Version_8::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

◆ armXaltitude

armXaltitude_type FrameCPP::Version_8::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_8::FrDetectorImpl::Data::armXazimuth
protectedinherited

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

◆ armXmidpoint

armXmidpoint_type FrameCPP::Version_8::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_8::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_8::FrDetectorImpl::Data::armYazimuth
protectedinherited

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

◆ armYmidpoint

armYmidpoint_type FrameCPP::Version_8::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_8::FrDetectorImpl::Data::aux
protectedinherited

Indentifier for user-provided structure for additional detector data.

◆ elevation

elevation_type FrameCPP::Version_8::FrDetectorImpl::Data::elevation
protectedinherited

Vertex elevation, in meters, relative to WGS84 ellipsoid.

◆ latitude

latitude_type FrameCPP::Version_8::FrDetectorImpl::Data::latitude
protectedinherited

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

◆ localTime

localTime_type FrameCPP::Version_8::FrDetectorImpl::Data::localTime
protectedinherited

Local seasonal time - UTC in seconds. If localTime % 1800 != 0 then localTime is undefined.

◆ longitude

longitude_type FrameCPP::Version_8::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_8::FrDetectorImpl::Data::MAX_REF = 2
staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_8::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.)

◆ prefix

CHAR FrameCPP::Version_8::FrDetectorImpl::Data::prefix
protectedinherited

Channel prefix for this detector as described here.

◆ 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_8::FrDetectorImpl::Data::table
protectedinherited

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


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