Routines upon which the version specific layers are built. More...

Classes
class	Array
	Storage class for array data streams of a frame. More...

class	BaseMemoryBufferT
	Buffer appropriate for caching frame data. More...

class	CheckSum

class	CheckSumCRC

class	CheckSumFilter
	Filtering algorythm for calculating checksums. More...

class	Container
	Container for Frame objects. More...

class	ContainerBase
	The base class for all containers. More...

struct	CRCModel

class	Description

class	DetectorNames
	Maintains information about known detectors. More...

class	Dictionary
	Keep track of structures written to or read from stream. More...

class	DynamicMemoryBufferT
	Buffer appropriate for caching frame data. More...

class	FrameBuffer
	Buffer appropriate for caching frame data. More...

class	FrameBufferInterface

class	FrameFilename
	Class to parse frame filename. More...

class	FrameH

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

class	FrameStream

class	FrameStreamBase

class	FrameStructCheckSum
	Per frame structure checksum. More...

class	FrDataObject

class	FrDetector

class	FrEndOfFile

class	FrHeader

class	FrObject

class	FrSH
	Interface definition for an FrSH structure. More...

class	FrStatData

class	FrTOC

class	FrTOCAdcDataInputFunctor

class	FrTOCPositionInputFunctor

class	FrVect

class	IFrameStream

class	IFrameStreamPlanWrapper
	Frame Reading FrameStreamPlanWrapper. More...

class	IFrameStreamWrapper
	Wrapper to properly cast return values into the namespace associated with the frame specification namespace. More...

class	IStream

class	IStringStream

class	MD5Sum

class	MD5SumFilter

class	MemoryBufferT
	Buffer appropriate for caching frame data. More...

class	OFrameStream

class	OStream

struct	PTR_STRUCT
	Holder of Stream reference to an object within the stream. More...

struct	PTR_STRUCT_BASE
	Holder of Stream reference to an object within the stream. More...

class	ROMemoryStreamBuf
	Handles a read-only memory stream. More...

class	SearchContainer
	A searchable container. More...

class	StreamBase

class	StreamFilter

class	StreamRef

class	StreamRef2
	Generalized common elements of frame structure. More...

class	StreamRefInterface

class	STRING

class	STRING_SHADOW

class	TOCInfo

class	Verify

class	VerifyException

class	VerifyObject

Typedefs
typedef BaseMemoryBufferT< ROMemoryStreamBuf >	ReadOnlyMemoryBuffer

typedef CRCModel< uint32_t, 0x04C11DB7, 0xFFFFFFFF, 0xFFFFFFFF >	crc32_model_type

typedef DynamicMemoryBufferT	DynamicMemoryBuffer

typedef MemoryBufferT	MemoryBuffer

Functions
template<>
const char *	Common::Description::Ascii< std::string > ()

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

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

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

void	AppendComment (std::string &Dest, const std::string &Text)

template<>
cmn_streamsize_type	Bytes (const Version_4::GPSTime &Time)

template<typename FrObjType >
bool	Compare (const FrObjType &FrObj, const FrameSpec::Object &Obj)

	INSTANTIATE (FrameSpec::Object, INT_4U)

	INSTANTIATE (FrDetector, INT_4U)

	INSTANTIATE (FrStatData, INT_4U)

template<>
INT_8U	IFrameStream::position< FrameSpec::Info::FSI_FR_ADC_DATA, std::string > (const FrTOC *TOC, INT_4U Frame, const std::string &Channel) const

template<>
INT_8U	IFrameStream::position< FrameSpec::Info::FSI_FR_ADC_DATA, INT_4U > (const FrTOC *TOC, INT_4U Frame, const INT_4U &Channel) const

template<>
INT_8U	IFrameStream::position< FrameSpec::Info::FSI_FR_EVENT, std::string > (const FrTOC *TOC, INT_4U Frame, const std::string &Channel) const

template<>
INT_8U	IFrameStream::position< FrameSpec::Info::FSI_FR_PROC_DATA, std::string > (const FrTOC *TOC, INT_4U Frame, const std::string &Channel) const

template<>
INT_8U	IFrameStream::position< FrameSpec::Info::FSI_FR_PROC_DATA, INT_4U > (const FrTOC *TOC, INT_4U Frame, const INT_4U &Channel) const

template<>
INT_8U	IFrameStream::position< FrameSpec::Info::FSI_FR_SER_DATA, std::string > (const FrTOC *TOC, INT_4U Frame, const std::string &Channel) const

template<>
INT_8U	IFrameStream::position< FrameSpec::Info::FSI_FR_SIM_DATA, std::string > (const FrTOC *TOC, INT_4U Frame, const std::string &Channel) const

template<>
INT_8U	IFrameStream::position< FrameSpec::Info::FSI_FR_SIM_EVENT, std::string > (const FrTOC *TOC, INT_4U Frame, const std::string &Channel) const

template<>
INT_8U	IFrameStream::position_index< FrameSpec::Info::FSI_FR_EVENT, std::string > (const FrTOC *TOC, const std::string &Channel, INT_4U Index) const

template<>
INT_8U	IFrameStream::position_index< FrameSpec::Info::FSI_FR_SIM_EVENT, std::string > (const FrTOC *TOC, const std::string &Channel, INT_4U Index) const

Variables
static const char *	DEFAULT_ORIGINATOR = "IGWD"

Detailed Description

Routines upon which the version specific layers are built.

Typedef Documentation

◆ crc32_model_type

typedef CRCModel< uint32_t, 0x04C11DB7, 0xFFFFFFFF, 0xFFFFFFFF > FrameCPP::Common::crc32_model_type

◆ DynamicMemoryBuffer

typedef DynamicMemoryBufferT FrameCPP::Common::DynamicMemoryBuffer

◆ MemoryBuffer

typedef MemoryBufferT FrameCPP::Common::MemoryBuffer

◆ ReadOnlyMemoryBuffer

typedef BaseMemoryBufferT< ROMemoryStreamBuf > FrameCPP::Common::ReadOnlyMemoryBuffer

Function Documentation

◆ AppendComment()

void FrameCPP::Common::AppendComment	(	std::string &	Dest,
		const std::string &	Text
	)

inline

◆ Bytes() [1/2]

template<>

cmn_streamsize_type FrameCPP::Common::Bytes ( const Version_4::GPSTime & Time )

inline

◆ Bytes() [2/2]

template<typename T >

streamsize_type FrameCPP::Common::Bytes ( const T & Data )

Return the number of bytes for given type.

Template Parameters

T	Specific type for which to retrieve the number of bytes.

Parameters

[in] Data The data to be read or written to a stream.

Returns: The number of bytes needed to read or write Data from or to a stream.

◆ Common::Description::Ascii< std::string >()

template<>

const char* FrameCPP::Common::Common::Description::Ascii< std::string > ( )

inline

◆ Compare()

template<typename FrObjType >

bool FrameCPP::Common::Compare	(	const FrObjType &	FrObj,
		const FrameSpec::Object &	Obj
	)

inline

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_ADC_DATA, INT_4U >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position< FrameSpec::Info::FSI_FR_ADC_DATA, INT_4U >	(	const FrTOC *	TOC,
		INT_4U	Frame,
		const INT_4U &	Channel
	)		const

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_ADC_DATA, std::string >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position< FrameSpec::Info::FSI_FR_ADC_DATA, std::string >	(	const FrTOC *	TOC,
		INT_4U	Frame,
		const std::string &	Channel
	)		const

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_EVENT, std::string >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position< FrameSpec::Info::FSI_FR_EVENT, std::string >	(	const FrTOC *	TOC,
		INT_4U	Frame,
		const std::string &	Channel
	)		const

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_PROC_DATA, INT_4U >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position< FrameSpec::Info::FSI_FR_PROC_DATA, INT_4U >	(	const FrTOC *	TOC,
		INT_4U	Frame,
		const INT_4U &	Channel
	)		const

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_PROC_DATA, std::string >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position< FrameSpec::Info::FSI_FR_PROC_DATA, std::string >	(	const FrTOC *	TOC,
		INT_4U	Frame,
		const std::string &	Channel
	)		const

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_SER_DATA, std::string >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position< FrameSpec::Info::FSI_FR_SER_DATA, std::string >	(	const FrTOC *	TOC,
		INT_4U	Frame,
		const std::string &	Channel
	)		const

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_SIM_DATA, std::string >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position< FrameSpec::Info::FSI_FR_SIM_DATA, std::string >	(	const FrTOC *	TOC,
		INT_4U	Frame,
		const std::string &	Channel
	)		const

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_SIM_EVENT, std::string >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position< FrameSpec::Info::FSI_FR_SIM_EVENT, std::string >	(	const FrTOC *	TOC,
		INT_4U	Frame,
		const std::string &	Channel
	)		const

◆ IFrameStream::position_index< FrameSpec::Info::FSI_FR_EVENT, std::string >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position_index< FrameSpec::Info::FSI_FR_EVENT, std::string >	(	const FrTOC *	TOC,
		const std::string &	Channel,
		INT_4U	Index
	)		const

◆ IFrameStream::position_index< FrameSpec::Info::FSI_FR_SIM_EVENT, std::string >()

template<>

INT_8U FrameCPP::Common::IFrameStream::position_index< FrameSpec::Info::FSI_FR_SIM_EVENT, std::string >	(	const FrTOC *	TOC,
		const std::string &	Channel,
		INT_4U	Index
	)		const

◆ INSTANTIATE() [1/3]

FrameCPP::Common::INSTANTIATE	(	FrameSpec::Object	,
		INT_4U
	)

◆ INSTANTIATE() [2/3]

FrameCPP::Common::INSTANTIATE	(	FrDetector	,
		INT_4U
	)

◆ INSTANTIATE() [3/3]

FrameCPP::Common::INSTANTIATE	(	FrStatData	,
		INT_4U
	)

◆ PromoteObject()

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
	)

inline

◆ VerifyObject()

template<typename T >

void FrameCPP::Common::VerifyObject	(	const T &	Obj,
		FrameSpec::Info::verify_type &	Verifier,
		IFrameStream &	Stream
	)

Verify an object.

Parameters

[in]	Obj	Object to be verified.
[in,out]	Verifier	Storage space to record state of object verification.
[in]	Stream	Stream from which Obj was read.

Variable Documentation

◆ DEFAULT_ORIGINATOR

const char* FrameCPP::Common::DEFAULT_ORIGINATOR = "IGWD"

static

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ crc32_model_type

◆ DynamicMemoryBuffer

◆ MemoryBuffer

◆ ReadOnlyMemoryBuffer

Function Documentation

◆ AppendComment()

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ Common::Description::Ascii< std::string >()

◆ Compare()

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_ADC_DATA, INT_4U >()

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_ADC_DATA, std::string >()

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_EVENT, std::string >()

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_PROC_DATA, INT_4U >()

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_PROC_DATA, std::string >()

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_SER_DATA, std::string >()

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_SIM_DATA, std::string >()

◆ IFrameStream::position< FrameSpec::Info::FSI_FR_SIM_EVENT, std::string >()

◆ IFrameStream::position_index< FrameSpec::Info::FSI_FR_EVENT, std::string >()

◆ IFrameStream::position_index< FrameSpec::Info::FSI_FR_SIM_EVENT, std::string >()

◆ INSTANTIATE() [1/3]

◆ INSTANTIATE() [2/3]

◆ INSTANTIATE() [3/3]

◆ PromoteObject()

◆ VerifyObject()

Variable Documentation

◆ DEFAULT_ORIGINATOR