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

Detector data. More...

#include <FrDetector.hh>

Inheritance diagram for FrameCPP::Version_8::FrDetector:
Collaboration diagram for FrameCPP::Version_8::FrDetector:

Public Types

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 STRING< INT_2U > string_2_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
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

 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 localTime_type LocalTime)
 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 localTime_type LocalTime)
 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
 
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.
 
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.
 
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 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 const Common::DescriptionStructDescription ()
 The description of structure.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
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.
 
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 struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
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 Public Attributes

static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

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

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 Types

typedef ObjectWithChecksum< Common::FrDetectorobject_type
 
typedef ObjectWithChecksum< Common::FrDetectorobject_type
 
typedef STRING io_name_type
 
typedef STRING io_name_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_typeobject_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 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
 
void save (Archive &archiver, const unsigned int version) const
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum.
 

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

◆ elevation_type

◆ io_name_type [1/2]

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

◆ io_name_type [2/2]

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

◆ istream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ latitude_type

◆ localTime_type

◆ longitude_type

◆ name_type

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ object_type [1/2]

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

◆ object_type [2/2]

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

◆ ostream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ prefix_type

◆ self_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ string_2_type [1/2]

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

◆ string_2_type [2/2]

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

◆ 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

Member Enumeration Documentation

◆ 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 

◆ 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 

Constructor & Destructor Documentation

◆ FrDetector() [1/10]

FrameCPP::Version_8::FrDetector::FrDetector ( )

Default constructor.

Returns
A new instance of an FrDetector object

◆ FrDetector() [2/10]

FrameCPP::Version_8::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 localTime_type LocalTime )

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.
[in]LocalTimeLocal seasonal time.
Returns
A new instance of an FrDetector object

◆ FrDetector() [3/10]

FrameCPP::Version_8::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_8::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_8::FrDetector::FrDetector ( istream_type & Stream)
private

◆ FrDetector() [6/10]

FrameCPP::Version_8::FrDetector::FrDetector ( )

Default constructor.

Returns
A new instance of an FrDetector object

◆ FrDetector() [7/10]

FrameCPP::Version_8::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 localTime_type LocalTime )

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.
[in]LocalTimeLocal seasonal time.
Returns
A new instance of an FrDetector object

◆ FrDetector() [8/10]

FrameCPP::Version_8::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_8::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_8::FrDetector::FrDetector ( istream_type & Stream)
private

Member Function Documentation

◆ Bytes() [1/2]

template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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

◆ Bytes() [2/2]

template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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

◆ CheckSumDataClass() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType, typename ChecksumType>
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType, typename ChecksumType>
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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.

◆ Create() [4/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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.

◆ Create() [5/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::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.

◆ FrameSpecDescription()

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

Return the dictionary name of the structure.

◆ FrameSpecId()

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

Return the dictionary name of the structure.

◆ FrameSpecName()

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

◆ GetArmXaltitude()

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

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

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

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

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

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

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

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

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

Retrieve the local seasonal time.

Returns
The local seasonal time.

◆ GetLongitude()

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

◆ GetName() [2/2]

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

◆ GetNameSlow()

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

Retrieve the name of the instrument.

Returns
The name of the instrument.

◆ GetPrefix()

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]

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

◆ load() [2/3]

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

◆ load() [3/3]

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

◆ Merge() [1/2]

FrDetector & FrameCPP::Version_8::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

◆ Merge() [2/2]

FrDetector & FrameCPP::Version_8::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_8::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.

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_8::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.

◆ operator==() [1/5]

virtual bool FrameCPP::Version_8::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.

◆ operator==() [2/5]

virtual bool FrameCPP::Version_8::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.

◆ operator==() [3/5]

bool FrameCPP::Version_8::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_8::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_8::FrDetectorImpl::Data::operator== ( Data const & RHS) const
inlineinherited

◆ pBytes() [1/2]

cmn_streamsize_type FrameCPP::Version_8::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< ObjectType, ChecksumType >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::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< ObjectType, ChecksumType >.

◆ pCreate() [1/2]

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

◆ pCreate() [2/2]

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

◆ Promote() [1/2]

ClassicIO< FrDetector >::promote_ret_type FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
staticinherited

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]

static promote_ret_type FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
staticinherited

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_8::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.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_8::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.

◆ pWrite() [1/2]

virtual void FrameCPP::Version_8::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< ObjectType, ChecksumType >.

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::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< ObjectType, ChecksumType >.

◆ RefAux() [1/2]

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

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

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

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]

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

◆ save() [2/3]

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

◆ save() [3/3]

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

◆ StructDescription() [1/2]

static const Common::Description * FrameCPP::Version_8::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_8::FrDetectorImpl::ClassicIO< FrDetector >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructName()

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

◆ TOCQuery() [1/2]

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

◆ TOCQuery() [2/2]

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

◆ vTOCQuery() [1/2]

virtual void FrameCPP::Version_8::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_8::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]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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)

◆ m_chkSum

template<typename ObjectType, typename ChecksumType>
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

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

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