ldas-tools-framecpp 2.9.2
|
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 | 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. | |
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::FrStatData | FrStatData |
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 |
Functions | |
template<typename T > | |
bool | compare (const T &LHS, const Common::FrameSpec::Object &Obj) |
Compare two frame objects. More... | |
template<typename T > | |
bool | IsOfType (Common::FrameSpec::Object *Obj) |
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. More... | |
std::string | GetVersion () |
Get the version of frameCPP. More... | |
template<typename T > | |
bool | NeedsToBeDemoted (Common::FrameSpec::Object *Obj) |
template<typename T > | |
bool | NeedsToBePromoted (Common::FrameSpec::Object *Obj) |
const FrDetector & | GetDetector (detector_location_type Location, const GPSTime &Time) |
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. More... | |
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 REAL_8 FrameCPP::delta_t_normalized_type |
typedef Version_8::FrameH FrameCPP::FrameH |
typedef Version::FrEndOfFileBase FrameCPP::FrEndOfFileBase |
typedef Version_8::FrEvent FrameCPP::FrEvent |
typedef Version_8::FrMsg FrameCPP::FrMsg |
typedef Version_8::FrSE FrameCPP::FrSE |
typedef Version_8::FrSH FrameCPP::FrSH |
typedef Version_8::FrTable FrameCPP::FrTable |
typedef Version_8::FrTOC FrameCPP::FrTOC |
typedef Version_8::FrVect FrameCPP::FrVect |
typedef Version::GPSTime FrameCPP::GPSTime |
typedef Version::IFrameStream FrameCPP::IFrameStream |
typedef Version::IFrameStreamPlan FrameCPP::IFrameStreamPlan |
typedef LDASTools::AL::GPSTime FrameCPP::start_time_normalized_type |
typedef INT_8U FrameCPP::streamsize_type |
typedef Version::STRING FrameCPP::STRING |
typedef CHAR_U FrameCPP::version_type |
enum FrameCPP::CODE |
enum FrameCPP::CODE |
enum FrameCPP::CODE |
|
inline |
Compare two frame objects.
[in] | LHS | The left hand side of the comparison. |
[in] | Obj | The right hand side of the comparison. |
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.
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.
const version_type FrameCPP::FrameSpecMinimum | ( | FRAME_SPEC_MIN | ) |
The earliest supported frame specification.
This is the earliest feature complete implementation of the frame specification.
std::string FrameCPP::GetBuildDate | ( | ) |
Get the date when frameCPP was built.
return: std::string - The string representation of when the library was
std::string FrameCPP::GetCVSDate | ( | ) |
Get the CVS date for this version of frameCPP.
return: std::string - The string representation of the cvs date
INT_2U FrameCPP::GetDataFormatVersion | ( | ) |
Return the data format version.
const FrDetector & FrameCPP::GetDetector | ( | detector_location_type | Location, |
const GPSTime & | Time | ||
) |
INT_2U FrameCPP::GetFrameLibraryMinorVersion | ( | ) |
Return the minor version of the frame library.
return: INT_2U - current minor version for the frame library
std::string FrameCPP::GetVersion | ( | ) |
Get the version of frameCPP.
const int FrameCPP::HostByteOrder | ( | BYTE_ORDER_HOST | ) |
Byte ordering of host.
void FrameCPP::Initialize | ( | ) |
Initialize the C++ Interface.
|
inline |
|
inline |
|
inline |