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  CheckSum
class  CheckSumCRC
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  crc_ldas
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  FrTOCAdcDataInputFunctor9
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  UnknownDescription
class  Verify
class  VerifyException
class  VerifyObject

Typedefs

typedef BaseMemoryBufferT< ROMemoryStreamBufReadOnlyMemoryBuffer
typedef boost::crc_optimal< 32, 0x04C11DB7, 0, 0xFFFFFFFF, false, false > boost_crc_cksum_type
typedef cksum_impl< boost_crc_cksum_typecksum_boost
 Implements Un*x cksum utility.
typedef cksum_impl< crc_ldascksum_ldas
typedef DynamicMemoryBufferT DynamicMemoryBuffer
typedef MemoryBufferT MemoryBuffer

Functions

template<>
void crc_ldas::process_eight_byte_chunck< boost::endian::order::big > (const value_type *&Current)
template<>
void crc_ldas::process_eight_byte_chunck< boost::endian::order::little > (const value_type *&Current)
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.
template<typename T>
void VerifyObject (const T &Obj, FrameSpec::Info::verify_type &Verifier, IFrameStream &Stream)
 Verify an object.
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)
auto IsIStream (StreamBase *Stream) -> decltype(dynamic_cast< IStream * >(Stream))
auto IsOStream (StreamBase *Stream) -> decltype(dynamic_cast< OStream * >(Stream))
void AppendComment (std::string &Dest, const std::string &Text, const cmn_streamsize_type MAX=~(INT_2U(0)))
template<>
cmn_streamsize_type Bytes (const Version_4::GPSTime &Time)
template<>
void crc_ldas::process_eight_byte_chunck< boost::endian::order::big > (const value_type *&Current)
template<>
void crc_ldas::process_eight_byte_chunck< boost::endian::order::little > (const value_type *&Current)
template<typename FrObjType>
bool Compare (const FrObjType &FrObj, const FrameSpec::Object &Obj)
template<>
const char * Common::Description::Ascii< std::string > ()
 INSTANTIATE (FrameSpec::Object, INT_4U)
 INSTANTIATE (FrDetector, INT_4U)
 INSTANTIATE (FrSH, 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
template<>
cmn_streamsize_type Bytes (const Version_4::GPSTime &Time)

Variables

template<class DC, class DI, int SPEC_VERSION_T>
const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & PTR_STRUCT< DC, DI, SPEC_VERSION_T >::NULL_PTR
template<class L>
const L STRING< L >::MAX_STRING_LENGTH = ~( L( 0 ) )
template<class L>
const L STRING_SHADOW< L >::MAX_STRING_LENGTH = ~( L( 0 ) )
static const char * DEFAULT_ORIGINATOR = "IGWD"

Detailed Description

Routines upon which the version specific layers are built.

Typedef Documentation

◆ boost_crc_cksum_type

typedef boost::crc_optimal< 32, 0x04C11DB7, 0, 0xFFFFFFFF, false, false > FrameCPP::Common::boost_crc_cksum_type

◆ cksum_boost

Implements Un*x cksum utility.

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

◆ cksum_ldas

◆ DynamicMemoryBuffer

◆ MemoryBuffer

◆ ReadOnlyMemoryBuffer

Function Documentation

◆ AppendComment()

void FrameCPP::Common::AppendComment ( std::string & Dest,
const std::string & Text,
const cmn_streamsize_type MAX = ~( INT_2U( 0 ) ) )
inline

◆ Bytes() [1/3]

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.

◆ Bytes() [2/3]

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

◆ Bytes() [3/3]

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

◆ Common::Description::Ascii< std::string >() [1/2]

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

◆ Common::Description::Ascii< std::string >() [2/2]

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

◆ crc_ldas::process_eight_byte_chunck< boost::endian::order::big >() [1/2]

template<>
void FrameCPP::Common::crc_ldas::process_eight_byte_chunck< boost::endian::order::big > ( const value_type *& Current)
inline

◆ crc_ldas::process_eight_byte_chunck< boost::endian::order::big >() [2/2]

template<>
void FrameCPP::Common::crc_ldas::process_eight_byte_chunck< boost::endian::order::big > ( const value_type *& Current)
inline

◆ crc_ldas::process_eight_byte_chunck< boost::endian::order::little >() [1/2]

template<>
void FrameCPP::Common::crc_ldas::process_eight_byte_chunck< boost::endian::order::little > ( const value_type *& Current)
inline

◆ crc_ldas::process_eight_byte_chunck< boost::endian::order::little >() [2/2]

template<>
void FrameCPP::Common::crc_ldas::process_eight_byte_chunck< boost::endian::order::little > ( const value_type *& Current)
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/4]

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

◆ INSTANTIATE() [2/4]

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

◆ INSTANTIATE() [3/4]

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

◆ INSTANTIATE() [4/4]

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

◆ IsIStream()

auto FrameCPP::Common::IsIStream ( StreamBase * Stream) -> decltype( dynamic_cast< IStream* >( Stream ) )
inline

◆ IsOStream()

auto FrameCPP::Common::IsOStream ( StreamBase * Stream) -> decltype( dynamic_cast< OStream* >( Stream ) )
inline

◆ PromoteObject()

◆ 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.

Variable Documentation

◆ DEFAULT_ORIGINATOR

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

◆ PTR_STRUCT< DC, DI, SPEC_VERSION_T >::NULL_PTR

template<class DC, class DI, int SPEC_VERSION_T>
const PTR_STRUCT< DC, DI, SPEC_VERSION_T >& FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::NULL_PTR
Initial value:
=
Holder of Stream reference to an object within the stream.
Definition PTR_STRUCT.hh:54

◆ STRING< L >::MAX_STRING_LENGTH

template<class L>
const L FrameCPP::Common::STRING< L >::MAX_STRING_LENGTH = ~( L( 0 ) )

◆ STRING_SHADOW< L >::MAX_STRING_LENGTH

template<class L>
const L FrameCPP::Common::STRING_SHADOW< L >::MAX_STRING_LENGTH = ~( L( 0 ) )