ldas-tools-framecpp 3.0.4
|
Detector data. More...
#include <FrDetector.hh>
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. | |
FrDetector & | Merge (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. | |
FrDetector & | Merge (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_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (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. | |
dataQualityOffset_type | GetDataQualityOffset () const |
Bit offset of the low order bit of the data quality mask. | |
const aux_type & | RefAux () const |
Identifier for vector for user-provided information. | |
aux_type & | RefAux () |
Identifier for vector for user-provided information. | |
const table_type & | RefTable () const |
Identifier for user-provided information in table format. | |
table_type & | RefTable () |
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 const Common::Description * | StructDescription () |
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 const CHAR * | GetPrefix (const dataQualityOffset_type DataQualityOffset) |
static dataQualityOffsets | GetDataQualityOffset (const std::string &Name) |
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 constexpr char | TAMA_300_PREFIX [2] = { 'T', '1' } |
static constexpr char | VIRGO_PREFIX [2] = { 'V', '1' } |
static constexpr char | GEO_600_PREFIX [2] = { 'G', '1' } |
static constexpr char | LHO_4K_PREFIX [2] = { 'H', '1' } |
static constexpr char | LLO_4K_PREFIX [2] = { 'L', '1' } |
static constexpr char | CIT_40_PREFIX [2] = { 'C', '1' } |
static constexpr char | ACIGA_PREFIX [2] = { 'U', '1' } |
static constexpr char | KAGRA_PREFIX [2] = { 'K', '1' } |
static constexpr char | LIGO_INDIA_PREFIX [2] = { 'A', '1' } |
static constexpr char | UNKNOWN_PREFIX [2] = { ' ', ' ' } |
static std::map< char[2], int > | prefix_mapping |
static struct_name_type | struct_name |
static struct_desc_type | struct_desc |
static struct_id_type | struct_id |
Protected Types | |
typedef boost::bimap< std::string, dataQualityOffsets > | name_map_type |
typedef boost::bimap< std::string, dataQualityOffsets > | prefix_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 const char * | ObjectStructName () const |
The name structure name of this object. | |
virtual const Common::Description * | GetDescription (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. | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual self_type * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
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. |
Static Protected Member Functions | |
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::FrDetector > | object_type |
typedef ObjectWithChecksum< Common::FrDetector > | object_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 Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
void | load (Archive &archiver, const unsigned int version) |
void | save (Archive &archiver, const unsigned int version) const |
Private Attributes | |
ChecksumType | m_chkSum |
Structure checksum. |
Detector data.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef boost::shared_ptr< FrDetector > FrameCPP::Version_9::FrDetector::FrDetectorCache_element |
typedef boost::shared_ptr< FrDetector > FrameCPP::Version_9::FrDetector::FrDetectorCache_element |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
inherited |
|
privateinherited |
|
private |
|
private |
|
inherited |
|
inherited |
|
protectedinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_9::FrDetector::FrDetector | ( | ) |
Default constructor.
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.
[in] | Name | Instrument name |
[in] | Prefix | Channel prefix for this detector |
[in] | Longitude | Detector vertex longitude |
[in] | Latitude | Detector vertex latitutde. |
[in] | Elevation | Vertex elevation. |
[in] | ArmXazimuth | Orientation of X arm. |
[in] | ArmYazimuth | Orientation of Y arm. |
[in] | ArmXaltitude | Altidue angle of X arm. |
[in] | ArmYaltitude | Altidue angle of Y arm. |
[in] | ArmXmidpoint | Distance between the detector vertex and the middle of the X cavity. |
[in] | ArmYmidpoint | Distance between the detector vertex and the middle of the Y cavity. |
FrameCPP::Version_9::FrDetector::FrDetector | ( | const FrDetector & | detector | ) |
Copy constructor.
[in] | detector | The source instance to copy |
FrameCPP::Version_9::FrDetector::FrDetector | ( | Previous::FrDetector & | Source, |
stream_base_type * | Stream ) |
Promotion Constructor.
[in] | Source | An FrDetector structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrDetector structure was read. |
|
private |
FrameCPP::Version_9::FrDetector::FrDetector | ( | ) |
Default constructor.
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.
[in] | Name | Instrument name |
[in] | Prefix | Channel prefix for this detector |
[in] | Longitude | Detector vertex longitude |
[in] | Latitude | Detector vertex latitutde. |
[in] | Elevation | Vertex elevation. |
[in] | ArmXazimuth | Orientation of X arm. |
[in] | ArmYazimuth | Orientation of Y arm. |
[in] | ArmXaltitude | Altidue angle of X arm. |
[in] | ArmYaltitude | Altidue angle of Y arm. |
[in] | ArmXmidpoint | Distance between the detector vertex and the middle of the X cavity. |
[in] | ArmYmidpoint | Distance between the detector vertex and the middle of the Y cavity. |
FrameCPP::Version_9::FrDetector::FrDetector | ( | const FrDetector & | detector | ) |
Copy constructor.
[in] | detector | The source instance to copy |
FrameCPP::Version_9::FrDetector::FrDetector | ( | Previous::FrDetector & | Source, |
stream_base_type * | Stream ) |
Promotion Constructor.
[in] | Source | An FrDetector structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrDetector structure was read. |
|
private |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
inlinestaticprotectedinherited |
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprivatevirtualinherited |
constructor - virtual
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
inlineprotectedvirtualinherited |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
|
inlineinherited |
Retrieve the altitude angle of X arm of the detector.
|
inlineinherited |
Retrieve the orientation of X arm of the detector.
|
inlineinherited |
Retrieve the midpoint of the X arm of the detector.
|
inlineinherited |
Retrieve the altitude angle of Y arm of the detector.
|
inlineinherited |
Retrieve the orientation of Y arm of the detector.
|
inlineinherited |
Retrieve the midpoint of the Y arm of the detector.
|
inlineinherited |
Bit offset of the low order bit of the data quality mask.
|
inlinestaticinherited |
|
inlineprotectedvirtualinherited |
The data structure description.
|
inlinestatic |
Retrieve detector information for static detectors.
[in] | Name | Reference the detector by its name |
|
inlinestatic |
Retrieve detector information for static detectors.
[in] | Name | Reference the detector by its name |
|
static |
Retrieve detector information for static detectors.
[in] | Offset | Reference the detector by its dataQualityOffset |
|
static |
Retrieve detector information for static detectors.
[in] | Offset | Reference the detector by its dataQualityOffset |
|
inlineinherited |
Retrieve the vertex elevation of the detector.
|
inlineinherited |
Retrieve the latitude of the detector vertex.
|
inlineinherited |
Retrieve the longitude of the detector vertex.
const std::string & FrameCPP::Version_9::FrDetector::GetName | ( | ) | const |
const std::string & FrameCPP::Version_9::FrDetector::GetName | ( | ) | const |
|
inlineinherited |
Retrieve the name of the instrument.
|
inlineinherited |
Retrieve the prefix of the instrument.
|
inlinestaticinherited |
[in] | DataQualityOffset | The data quality offset of the left bit. |
|
inlineprivateinherited |
FrDetector & FrameCPP::Version_9::FrDetector::Merge | ( | const FrDetector & | RHS | ) |
Merge with another FrDetector.
[in] | RHS | The source of the information to append to this FrDetector structure. |
FrDetector & FrameCPP::Version_9::FrDetector::Merge | ( | const FrDetector & | RHS | ) |
Merge with another FrDetector.
[in] | RHS | The source of the information to append to this FrDetector structure. |
|
inlineprotectedvirtualinherited |
The name structure name of this object.
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrDetector object to be compared. |
bool FrameCPP::Version_9::FrDetector::operator== | ( | const FrDetector & | RHS | ) | const |
equality operator
[in] | RHS | The FrDetector object to be compared. |
|
inlineinherited |
|
inlineprotectedvirtualinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Virtual constructor.
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlinestaticprotectedinherited |
|
staticinherited |
|
inlineprotectedvirtualinherited |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineinherited |
Identifier for vector for user-provided information.
|
inlineinherited |
Identifier for vector for user-provided information.
|
inlineinherited |
Identifier for user-provided information in table format.
|
inlineinherited |
Identifier for user-provided information in table format.
|
inlineprivateinherited |
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
|
inlineinherited |
|
inherited |
|
protectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
virtualinherited |
Write object to the stream.
|
virtualinherited |
Write object to the stream.
|
staticconstexprinherited |
|
protectedinherited |
Altitude (pitch) angle to X arm, measured in radians above horizon (local tangent to WGS84 ellipsoid) -pi/2 < ArmXaltitude <= pi/2
|
protectedinherited |
Orientation of X arm, measured in radians East of North (0 <= ArmXazimuth < 2pi)
|
protectedinherited |
Distance between the detector vertex and the middle of the X cavity (meters) (should be zero for bars).
|
protectedinherited |
Altitude (pitch) angle to Y arm, measured in radians above horizon (local tangent to WGS84 ellipsoid) -pi/2 < ArmXaltitude <= pi/2
|
protectedinherited |
Orientation of Y arm, measured in radians East of North (0 <= ArmYazimuth < 2pi)
|
protectedinherited |
Distance between the detector vertex and the middle of the Y cavity (meters) (should be zero for bars).
|
protectedinherited |
Indentifier for user-provided structure for additional detector data.
|
staticconstexprinherited |
|
protectedinherited |
Data quality offset Bit offset of the low order bit of the data quality mask.
|
protectedinherited |
Vertex elevation, in meters, relative to WGS84 ellipsoid.
|
staticconstexprinherited |
|
staticconstexprinherited |
|
protectedinherited |
Detector vertex latitude, geographical coordinated: radians; Value >= 0 >= N of Equator (-pi/2 < Latitude <= +pi/2).
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |
|
protectedinherited |
Detector vertex longitude, geographical coordinates: radians; Value > 0 >= E of Greenwich (-pi < Longitude <= +pi)
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
staticconstexprprotectedinherited |
|
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.)
|
staticprotectedinherited |
|
protectedinherited |
Channel prefix for this detector as described here.
|
staticprotectedinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
protectedinherited |
Identifier fo ruser-provided table structure for additional detector data.
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |