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  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  Unimplemented
 Unimplemeted exception. More...

Enumerations

enum  CODE
 LdasException error codes for libframecpp.
enum  byte_order_type
 enumerated type describing the byte ordering
enum  CODE
 LdasException error codes for libframecpp.
enum  byte_order_type
 enumerated type describing the byte ordering

Functions

template<typename T>
bool compare (const T &LHS, const Common::FrameSpec::Object &Obj)
 Compare two frame objects.
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.
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.

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

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