ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP Namespace Reference

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

Namespaces

namespace  Common
 Routines upon which the version specific layers are built.
 
namespace  Compression
 Routines related to compression algorithems.
 
namespace  Test
 
namespace  v3
 
namespace  v4
 
namespace  v5
 
namespace  v8
 
namespace  v9
 
namespace  Version_3
 Implementation of the version 3 specification.
 
namespace  Version_4
 Implementation of the version 4 specification.
 
namespace  Version_6
 Implementation of the version 6 specification.
 
namespace  Version_7
 Implementation of the version 7 specification.
 
namespace  Version_8
 Implementation of the version 8 specification.
 
namespace  Version_9
 Implementation of the version 9 specification.
 

Classes

class  FrUncompressable
 
class  FrZCompIRangeError
 
class  FrZCompRangeError
 
class  IFrameFStream
 
class  IFrameFStreamPlan
 
class  OFrameFStream
 
class  Unimplemented
 Unimplemeted exception. More...
 

Typedefs

typedef Common::StreamBase stream_base_type
 
typedef Common::IStream istream_type
 
typedef Common::OStream ostream_type
 
typedef INT_8U streamsize_type
 
typedef CHAR_U version_type
 
typedef Common::FrameSpec::size_type cmn_streamsize_type
 
typedef LDASTools::AL::GPSTime start_time_normalized_type
 
typedef REAL_8 delta_t_normalized_type
 
typedef Common::FrameSpec::Object Object
 
typedef Version::Dimension Dimension
 
typedef Version::FrAdcData FrAdcData
 
typedef Version::FrameH FrameH
 
typedef Version::IFrameStream IFrameStream
 
typedef Common::OFrameStream OFrameStream
 
typedef Version::FrDetector FrDetector
 
typedef Version::FrEndOfFileBase FrEndOfFileBase
 
typedef Version::FrEvent FrEvent
 
typedef Version::FrHistory FrHistory
 
typedef Version::FrMsg FrMsg
 
typedef Version::FrProcData FrProcData
 
typedef Version::FrRawData FrRawData
 
typedef Version::FrSE FrSE
 
typedef Version::FrSerData FrSerData
 
typedef Version::FrSH FrSH
 
typedef Version::FrSimData FrSimData
 
typedef Version::FrSimEvent FrSimEvent
 
typedef Version::FrSummary FrSummary
 
typedef Version::FrTable FrTable
 
typedef Version::FrTOC FrTOC
 
typedef Version::FrVect FrVect
 
typedef Version::GPSTime GPSTime
 
typedef Version::IFrameStreamPlan IFrameStreamPlan
 
typedef Version::STRING STRING
 
typedef Version_6::FrEndOfFile FrEndOfFile
 
typedef Version_6::FrEndOfFrame FrEndOfFrame
 
typedef Version_6::FrHeader FrHeader
 
typedef Version_6::FrStatData FrStatData
 

Enumerations

enum  CODE { BAD_FRAME_FILE , BAD_FRAME_FILE }
 LdasException error codes for libframecpp. More...
 
enum  byte_order_type {
  BYTE_ORDER_BIG_ENDIAN , BYTE_ORDER_LITTLE_ENDIAN , BYTE_ORDER_HOST = BYTE_ORDER_LITTLE_ENDIAN , BYTE_ORDER_BIG_ENDIAN ,
  BYTE_ORDER_LITTLE_ENDIAN , BYTE_ORDER_HOST = BYTE_ORDER_LITTLE_ENDIAN
}
 enumerated type describing the byte ordering More...
 
enum  CODE { BAD_FRAME_FILE , BAD_FRAME_FILE }
 LdasException error codes for libframecpp. More...
 
enum  byte_order_type {
  BYTE_ORDER_BIG_ENDIAN , BYTE_ORDER_LITTLE_ENDIAN , BYTE_ORDER_HOST = BYTE_ORDER_LITTLE_ENDIAN , BYTE_ORDER_BIG_ENDIAN ,
  BYTE_ORDER_LITTLE_ENDIAN , BYTE_ORDER_HOST = BYTE_ORDER_LITTLE_ENDIAN
}
 enumerated type describing the byte ordering More...
 

Functions

template<typename T >
bool compare (const T &LHS, const Common::FrameSpec::Object &Obj)
 Compare two frame objects.
 
template<typename T >
bool IsOfType (Common::FrameSpec::Object *Obj)
 
const version_type FrameSpecMinimum (FRAME_SPEC_MIN)
 The earliest supported frame specification.
 
const version_type FrameSpecCurrent (FRAME_SPEC_CURRENT)
 Currentently supported frame specification.
 
const version_type FrameSpecMaximum (FRAME_SPEC_MAX)
 Maximum supported frame spec.
 
const int HostByteOrder (BYTE_ORDER_HOST)
 Byte ordering of host.
 
std::string GetVersion ()
 Get the version of frameCPP.
 
template<typename StreamType >
Common::FrameSpec::version_type StreamVersion (const StreamType &Stream)
 Return the version of the stream.
 
template<typename T >
bool NeedsToBeDemoted (Common::FrameSpec::Object *Obj)
 
template<typename T >
bool NeedsToBePromoted (Common::FrameSpec::Object *Obj)
 
std::string GetCVSDate ()
 Get the CVS date for this version of frameCPP.
 
std::string GetBuildDate ()
 Get the date when frameCPP was built.
 
INT_2U GetDataFormatVersion ()
 Return the data format version.
 
INT_2U GetFrameLibraryMinorVersion ()
 Return the minor version of the frame library.
 
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.

Typedef Documentation

◆ cmn_streamsize_type

◆ delta_t_normalized_type

◆ Dimension

◆ FrAdcData

◆ FrameH

◆ FrDetector

◆ FrEndOfFile

◆ FrEndOfFileBase

typedef Version::FrEndOfFileBase FrameCPP::FrEndOfFileBase

◆ FrEndOfFrame

◆ FrEvent

◆ FrHeader

◆ FrHistory

◆ FrMsg

◆ FrProcData

◆ FrRawData

◆ FrSE

◆ FrSerData

◆ FrSH

◆ FrSimData

◆ FrSimEvent

◆ FrStatData

typedef Version_9::FrStatData FrameCPP::FrStatData

◆ FrSummary

◆ FrTable

◆ FrTOC

◆ FrVect

◆ GPSTime

typedef Version::GPSTime FrameCPP::GPSTime

◆ IFrameStream

typedef Version::IFrameStream FrameCPP::IFrameStream

◆ IFrameStreamPlan

typedef Version::IFrameStreamPlan FrameCPP::IFrameStreamPlan

◆ istream_type

◆ Object

◆ OFrameStream

◆ ostream_type

◆ start_time_normalized_type

typedef LDASTools::AL::GPSTime FrameCPP::start_time_normalized_type

◆ stream_base_type

◆ streamsize_type

typedef INT_8U FrameCPP::streamsize_type

◆ STRING

typedef Version::STRING FrameCPP::STRING

◆ version_type

typedef CHAR_U FrameCPP::version_type

Enumeration Type Documentation

◆ byte_order_type [1/2]

enumerated type describing the byte ordering

Enumerator
BYTE_ORDER_BIG_ENDIAN 
BYTE_ORDER_LITTLE_ENDIAN 
BYTE_ORDER_HOST 
BYTE_ORDER_BIG_ENDIAN 
BYTE_ORDER_LITTLE_ENDIAN 
BYTE_ORDER_HOST 

◆ byte_order_type [2/2]

enumerated type describing the byte ordering

Enumerator
BYTE_ORDER_BIG_ENDIAN 
BYTE_ORDER_LITTLE_ENDIAN 
BYTE_ORDER_HOST 
BYTE_ORDER_BIG_ENDIAN 
BYTE_ORDER_LITTLE_ENDIAN 
BYTE_ORDER_HOST 

◆ CODE [1/2]

LdasException error codes for libframecpp.

Enumerator
BAD_FRAME_FILE 
BAD_FRAME_FILE 

◆ CODE [2/2]

LdasException error codes for libframecpp.

Enumerator
BAD_FRAME_FILE 
BAD_FRAME_FILE 

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

◆ HostByteOrder()

const int FrameCPP::HostByteOrder ( BYTE_ORDER_HOST )

Byte ordering of host.

◆ Initialize()

void FrameCPP::Initialize ( )

Initialize the C++ Interface.

◆ IsOfType()

template<typename T >
bool FrameCPP::IsOfType ( Common::FrameSpec::Object * Obj)
inline

◆ NeedsToBeDemoted()

template<typename T >
bool FrameCPP::NeedsToBeDemoted ( Common::FrameSpec::Object * Obj)
inline

◆ NeedsToBePromoted()

template<typename T >
bool FrameCPP::NeedsToBePromoted ( Common::FrameSpec::Object * Obj)
inline

◆ StreamVersion()

template<typename StreamType >
Common::FrameSpec::version_type FrameCPP::StreamVersion ( const StreamType & Stream)
inline

Return the version of the stream.

This template attempts to evaluate the version of the stream being read or written.

Parameters
[in]StreamStream to be evaluated
Returns
If the version of the Stream can be derived, then that version version number is returned, FRAME_SPEC_CURRENT otherwise.