ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Common Namespace Reference

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  CheckSumFilter
 Filtering algorythm for calculating checksums. More...
class  cksum_impl
 Compute CRC checksum with length encoding. More...
class  Container
 Container for Frame objects. More...
class  ContainerBase
 The base class for all containers. More...
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  FrameFilename
 Class to parse frame filename. More...
class  FrameSpec
 Description of frame specification information. The information contained here allows for information needed to describe a specific frame specification implementation. More...
class  FrameStructCheckSum
 Per frame structure checksum. More...
class  FrSH
 Interface definition for an FrSH structure. More...
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  MemoryBufferT
 Buffer appropriate for caching frame data. More...
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  StreamRef2
 Generalized common elements of frame structure. More...

Typedefs

typedef cksum_impl< boost_crc_cksum_type > cksum_boost
 Implements Un*x cksum utility.

Functions

template<typename T>
streamsize_type Bytes (const T &Data)
 Return the number of bytes for given type.
template<typename T>
void VerifyObject (const T &Obj, FrameSpec::Info::verify_type &Verifier, IFrameStream &Stream)
 Verify an object.

Detailed Description

Routines upon which the version specific layers are built.

Typedef Documentation

◆ cksum_boost

typedef cksum_impl< boost_crc_cksum_type > FrameCPP::Common::cksum_boost

Implements Un*x cksum utility.

This implements the CRC checksum as defined by the Un*x command of hte same name

Function Documentation

◆ Bytes()

template<typename T>
streamsize_type FrameCPP::Common::Bytes ( const T & Data)

Return the number of bytes for given type.

Template Parameters
TSpecific type for which to retrieve the number of bytes.
Parameters
[in]DataThe 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.

◆ VerifyObject()

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

Verify an object.

Parameters
[in]ObjObject to be verified.
[in,out]VerifierStorage space to record state of object verification.
[in]StreamStream from which Obj was read.