FrameCPP Namespace Reference

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

Namespaces
	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.
	Version_9
	Implementation of the version 9 specification.

Functions
INT_2U	GetDataFormatVersion ()
	Return the data format version. More...
std::string	GetVersion ()
template<typename StreamType >
Common::FrameSpec::version_type	StreamVersion (const StreamType &Stream)
	Return the version of the stream. 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	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.

Function Documentation

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

(

)

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]

Stream

Stream to be evaluated

Returns

If the version of the Stream can be derived, then that version version number is returned, FRAME_SPEC_CURRENT otherwise.