ldas-tools-framecpp  2.9.3
Namespaces | Classes | Enumerations | Functions
FrameCPP Namespace Reference

I/O library for implementing the LIGO/Virgo frame specification. More...

Namespaces

 Common
 Routines upon which the version specific layers are built.
 
 Compression
 Routines related to compression algorithems.
 
 Version_3
 Implementation of the version 3 specification.
 
 Version_4
 Implementation of the version 4 specification.
 
 Version_6
 Implementation of the version 6 specification.
 
 Version_7
 Implementation of the version 7 specification.
 
 Version_8
 Implementation of the version 8 specification.
 

Classes

class  Unimplemented
 Unimplemeted exception. More...
 

Enumerations

enum  CODE
 LdasException error codes for libframecpp.
 
enum  byte_order_type
 enumerated type describing the byte ordering
 
enum  detector_location_type {
  DETECTOR_LOCATION_G1 , DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_K1 ,
  DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_T1 , DETECTOR_LOCATION_V1 , DETECTOR_LOCATION_G1 ,
  DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_K1 , DETECTOR_LOCATION_L1 ,
  DETECTOR_LOCATION_T1 , DETECTOR_LOCATION_V1 , DETECTOR_LOCATION_G1 , DETECTOR_LOCATION_H1 ,
  DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_K1 , DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_T1 ,
  DETECTOR_LOCATION_V1
}
 
enum  CODE
 LdasException error codes for libframecpp.
 
enum  byte_order_type
 enumerated type describing the byte ordering
 
enum  detector_location_type {
  DETECTOR_LOCATION_G1 , DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_K1 ,
  DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_T1 , DETECTOR_LOCATION_V1 , DETECTOR_LOCATION_G1 ,
  DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_K1 , DETECTOR_LOCATION_L1 ,
  DETECTOR_LOCATION_T1 , DETECTOR_LOCATION_V1 , DETECTOR_LOCATION_G1 , DETECTOR_LOCATION_H1 ,
  DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_K1 , DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_T1 ,
  DETECTOR_LOCATION_V1
}
 
enum  CODE
 LdasException error codes for libframecpp.
 
enum  byte_order_type
 enumerated type describing the byte ordering
 
enum  detector_location_type {
  DETECTOR_LOCATION_G1 , DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_K1 ,
  DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_T1 , DETECTOR_LOCATION_V1 , DETECTOR_LOCATION_G1 ,
  DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_K1 , DETECTOR_LOCATION_L1 ,
  DETECTOR_LOCATION_T1 , DETECTOR_LOCATION_V1 , DETECTOR_LOCATION_G1 , DETECTOR_LOCATION_H1 ,
  DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_K1 , DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_T1 ,
  DETECTOR_LOCATION_V1
}
 

Functions

template<typename T >
bool compare (const T &LHS, const Common::FrameSpec::Object &Obj)
 Compare two frame objects. More...
 
const version_type FrameSpecMinimum (FRAME_SPEC_MIN)
 The earliest supported frame specification. More...
 
const version_type FrameSpecCurrent (FRAME_SPEC_CURRENT)
 Currentently supported frame specification. More...
 
const version_type FrameSpecMaximum (FRAME_SPEC_MAX)
 Maximum supported frame spec. More...
 
const int HostByteOrder (BYTE_ORDER_HOST)
 Byte ordering of host.
 
std::string GetVersion ()
 Get the version of frameCPP. More...
 
std::string GetCVSDate ()
 Get the CVS date for this version of frameCPP. More...
 
std::string GetBuildDate ()
 Get the date when frameCPP was built. More...
 
INT_2U GetDataFormatVersion ()
 Return the data format version. More...
 
INT_2U GetFrameLibraryMinorVersion ()
 Return the minor version of the frame library. More...
 
void Initialize ()
 Initialize the C++ Interface.
 

Detailed Description

I/O library for implementing the LIGO/Virgo frame specification.

All elements described within this namespace are intended to implement the various frame specifications created by LIGO/Virgo.

Enumeration Type Documentation

◆ detector_location_type [1/3]

Enumerator
DETECTOR_LOCATION_G1 

GEO.

DETECTOR_LOCATION_H1 

Hanford 4k.

DETECTOR_LOCATION_H2 

Hanford 2k.

DETECTOR_LOCATION_K1 

KAGRA.

DETECTOR_LOCATION_L1 

Livingston.

DETECTOR_LOCATION_T1 

TAMA.

DETECTOR_LOCATION_V1 

Virgo.

DETECTOR_LOCATION_G1 

GEO.

DETECTOR_LOCATION_H1 

Hanford 4k.

DETECTOR_LOCATION_H2 

Hanford 2k.

DETECTOR_LOCATION_K1 

KAGRA.

DETECTOR_LOCATION_L1 

Livingston.

DETECTOR_LOCATION_T1 

TAMA.

DETECTOR_LOCATION_V1 

Virgo.

DETECTOR_LOCATION_G1 

GEO.

DETECTOR_LOCATION_H1 

Hanford 4k.

DETECTOR_LOCATION_H2 

Hanford 2k.

DETECTOR_LOCATION_K1 

KAGRA.

DETECTOR_LOCATION_L1 

Livingston.

DETECTOR_LOCATION_T1 

TAMA.

DETECTOR_LOCATION_V1 

Virgo.

◆ detector_location_type [2/3]

Enumerator
DETECTOR_LOCATION_G1 

GEO.

DETECTOR_LOCATION_H1 

Hanford 4k.

DETECTOR_LOCATION_H2 

Hanford 2k.

DETECTOR_LOCATION_K1 

KAGRA.

DETECTOR_LOCATION_L1 

Livingston.

DETECTOR_LOCATION_T1 

TAMA.

DETECTOR_LOCATION_V1 

Virgo.

DETECTOR_LOCATION_G1 

GEO.

DETECTOR_LOCATION_H1 

Hanford 4k.

DETECTOR_LOCATION_H2 

Hanford 2k.

DETECTOR_LOCATION_K1 

KAGRA.

DETECTOR_LOCATION_L1 

Livingston.

DETECTOR_LOCATION_T1 

TAMA.

DETECTOR_LOCATION_V1 

Virgo.

DETECTOR_LOCATION_G1 

GEO.

DETECTOR_LOCATION_H1 

Hanford 4k.

DETECTOR_LOCATION_H2 

Hanford 2k.

DETECTOR_LOCATION_K1 

KAGRA.

DETECTOR_LOCATION_L1 

Livingston.

DETECTOR_LOCATION_T1 

TAMA.

DETECTOR_LOCATION_V1 

Virgo.

◆ detector_location_type [3/3]

Enumerator
DETECTOR_LOCATION_G1 

GEO.

DETECTOR_LOCATION_H1 

Hanford 4k.

DETECTOR_LOCATION_H2 

Hanford 2k.

DETECTOR_LOCATION_K1 

KAGRA.

DETECTOR_LOCATION_L1 

Livingston.

DETECTOR_LOCATION_T1 

TAMA.

DETECTOR_LOCATION_V1 

Virgo.

DETECTOR_LOCATION_G1 

GEO.

DETECTOR_LOCATION_H1 

Hanford 4k.

DETECTOR_LOCATION_H2 

Hanford 2k.

DETECTOR_LOCATION_K1 

KAGRA.

DETECTOR_LOCATION_L1 

Livingston.

DETECTOR_LOCATION_T1 

TAMA.

DETECTOR_LOCATION_V1 

Virgo.

DETECTOR_LOCATION_G1 

GEO.

DETECTOR_LOCATION_H1 

Hanford 4k.

DETECTOR_LOCATION_H2 

Hanford 2k.

DETECTOR_LOCATION_K1 

KAGRA.

DETECTOR_LOCATION_L1 

Livingston.

DETECTOR_LOCATION_T1 

TAMA.

DETECTOR_LOCATION_V1 

Virgo.

Function Documentation

◆ compare()

template<typename T >
bool FrameCPP::compare ( const T &  LHS,
const Common::FrameSpec::Object Obj 
)
inline

Compare two frame objects.

Parameters
[in]LHSThe left hand side of the comparison.
[in]ObjThe right hand side of the comparison.
Returns
The value true is returned if the two objects are equivelent; false otherwise.

◆ FrameSpecCurrent()

const version_type FrameCPP::FrameSpecCurrent ( FRAME_SPEC_CURRENT  )

Currentently supported frame specification.

This is the latest version of the frame specification that is fully supported. By default, this version of the frame specification will be used to create memory objects. Also, output data streams will be generated according to this version of the frame specification.

◆ FrameSpecMaximum()

const version_type FrameCPP::FrameSpecMaximum ( FRAME_SPEC_MAX  )

Maximum supported frame spec.

This represents the maximum frame specification this is at least partially implemented. If it exceeds FrmaeSpecCurrent, it is not guaranteed to be complete. It allows for implementin and testing of Alpha and Beta versions of the frame specification.

◆ FrameSpecMinimum()

const version_type FrameCPP::FrameSpecMinimum ( FRAME_SPEC_MIN  )

The earliest supported frame specification.

This is the earliest feature complete implementation of the frame specification.

◆ GetBuildDate()

std::string FrameCPP::GetBuildDate ( )

Get the date when frameCPP was built.

return: std::string - The string representation of when the library was

◆ GetCVSDate()

std::string FrameCPP::GetCVSDate ( )

Get the CVS date for this version of frameCPP.

return: std::string - The string representation of the cvs date

◆ GetDataFormatVersion()

INT_2U FrameCPP::GetDataFormatVersion ( )

Return the data format version.

Returns
current version of frame spec.

◆ GetFrameLibraryMinorVersion()

INT_2U FrameCPP::GetFrameLibraryMinorVersion ( )

Return the minor version of the frame library.

return: INT_2U - current minor version for the frame library

◆ GetVersion()

std::string FrameCPP::GetVersion ( )

Get the version of frameCPP.

Returns
The string representation of the version of frameCPP