#include <iostream>
#include <memory>
#include <sstream>
#include <stdexcept>
#include <boost/pointer_cast.hpp>
#include <boost/shared_ptr.hpp>
#include "ldastoolsal/gpstime.hh"
#include "ldastoolsal/unordered_map.hh"
#include "ldastoolsal/types.hh"

Include dependency graph for FrameSpec.hh:

Classes
class	FrameCPP::Common::FrameSpec
	Description of frame specification information. The information contained here allows for information needed to describe a specific frame specification implementation. More...

class	FrameCPP::Common::FrameSpec::ObjectInterface
	Interface to Objects. More...

class	FrameCPP::Common::FrameSpec::Object
	Base for all frame objects. More...

class	FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >
	Support checksumed objects. More...

class	FrameCPP::Common::FrameSpec::Info

class	FrameCPP::Unimplemented
	Unimplemeted exception. More...

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

namespace	FrameCPP::Common
	Routines upon which the version specific layers are built.

Macros
#define	FRAME_SPEC_MIN 3
	Minimal version of frame specification which is supported.

#define	FRAME_SPEC_CURRENT 9
	Default version of frame specification which is supported.

#define	FRAME_SPEC_MAX 9
	Maximum version of frame specification which is supported.

#define	FRAMECPP_VERSION "3.0.4"
	Version number as an ascii string.

#define	FRAMECPP_VERSION_NUMBER
	Version number as a numeric value.

#define	FRAMECPP_BUILD_DATE "2024-08-29T13:44:28"
	Date of the build.

Typedefs
typedef Common::StreamBase	FrameCPP::stream_base_type

typedef Common::IStream	FrameCPP::istream_type

typedef Common::OStream	FrameCPP::ostream_type

typedef INT_8U	FrameCPP::streamsize_type

typedef CHAR_U	FrameCPP::version_type

typedef Common::FrameSpec::size_type	FrameCPP::cmn_streamsize_type

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

typedef REAL_8	FrameCPP::delta_t_normalized_type

typedef Common::FrameSpec::Object	FrameCPP::Object

Enumerations
enum	FrameCPP::CODE { FrameCPP::BAD_FRAME_FILE , FrameCPP::BAD_FRAME_FILE }
	LdasException error codes for libframecpp. More...

enum	FrameCPP::byte_order_type { FrameCPP::BYTE_ORDER_BIG_ENDIAN , FrameCPP::BYTE_ORDER_LITTLE_ENDIAN , FrameCPP::BYTE_ORDER_HOST = BYTE_ORDER_BIG_ENDIAN , FrameCPP::BYTE_ORDER_BIG_ENDIAN , FrameCPP::BYTE_ORDER_LITTLE_ENDIAN , FrameCPP::BYTE_ORDER_HOST = BYTE_ORDER_BIG_ENDIAN }
	enumerated type describing the byte ordering More...

Functions
template<typename T>
streamsize_type	FrameCPP::Common::Bytes (const T &Data)
	Return the number of bytes for given type.

template<typename T>
void	FrameCPP::Common::VerifyObject (const T &Obj, FrameSpec::Info::verify_type &Verifier, IFrameStream &Stream)
	Verify an object.

FrameSpec::ObjectInterface::promote_ret_type	FrameCPP::Common::PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj)

template<typename T>
bool	FrameCPP::compare (const T &LHS, const Common::FrameSpec::Object &Obj)
	Compare two frame objects.

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

const version_type	FrameCPP::FrameSpecMinimum (FRAME_SPEC_MIN)
	The earliest supported frame specification.

const version_type	FrameCPP::FrameSpecCurrent (FRAME_SPEC_CURRENT)
	Currentently supported frame specification.

const version_type	FrameCPP::FrameSpecMaximum (FRAME_SPEC_MAX)
	Maximum supported frame spec.

const int	FrameCPP::HostByteOrder (BYTE_ORDER_HOST)
	Byte ordering of host.

std::string	FrameCPP::GetVersion ()
	Get the version of frameCPP.

Macro Definition Documentation

◆ FRAME_SPEC_CURRENT

#define FRAME_SPEC_CURRENT 9

Default version of frame specification which is supported.

This define can be used to test the default frame specification that is supported by the library.

◆ FRAME_SPEC_MAX

#define FRAME_SPEC_MAX 9

Maximum version of frame specification which is supported.

This define can be used to test the maximum frame specification that is supported by the library.

◆ FRAME_SPEC_MIN

#define FRAME_SPEC_MIN 3

Minimal version of frame specification which is supported.

This define can be used to test the minimal frame specification that is supported by the library.

◆ FRAMECPP_BUILD_DATE

#define FRAMECPP_BUILD_DATE "2024-08-29T13:44:28"

Date of the build.

This string contains the date when the library was built. A common use of this information is in FrHistory records.

◆ FRAMECPP_VERSION

#define FRAMECPP_VERSION "3.0.4"

Version number as an ascii string.

◆ FRAMECPP_VERSION_NUMBER

#define FRAMECPP_VERSION_NUMBER

Value:

  ( (3 * 100 * 1000)       \
    + (0 * 1000)             \
    + (4) )

Version number as a numeric value.

This is a numeric representation of the package version of the form: [M]Mmmppp where:

M = Major digit

m = minor digit

p = patch digit

Classes

Namespaces

Macros

Typedefs

Enumerations