ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrVectImpl::ClassicIO< T > Class Template Reference

#include <FrVectClassicIO.hh>

Inheritance diagram for FrameCPP::Version_9::FrVectImpl::ClassicIO< T >:
Collaboration diagram for FrameCPP::Version_9::FrVectImpl::ClassicIO< T >:

Classes

class  DimBuffer

Public Types

enum  compression_scheme_type {
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , NONE = RAW , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , NONE = RAW
}
enum  compression_scheme_type {
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , NONE = RAW , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) , CST_DECL =( RAW, 0x00 ) ,
  CST_DECL =( RAW, 0x00 ) , NONE = RAW
}
enum  data_types_type {
  FR_VECT_C = 0 , FR_VECT_2S = 1 , FR_VECT_8R = 2 , FR_VECT_4R = 3 ,
  FR_VECT_4S = 4 , FR_VECT_8S = 5 , FR_VECT_8C = 6 , FR_VECT_16C = 7 ,
  FR_VECT_STRING = 8 , FR_VECT_2U = 9 , FR_VECT_4U = 10 , FR_VECT_8U = 11 ,
  FR_VECT_1U = 12 , FR_VECT_C = 0 , FR_VECT_2S = 1 , FR_VECT_8R = 2 ,
  FR_VECT_4R = 3 , FR_VECT_4S = 4 , FR_VECT_8S = 5 , FR_VECT_8C = 6 ,
  FR_VECT_16C = 7 , FR_VECT_STRING = 8 , FR_VECT_2U = 9 , FR_VECT_4U = 10 ,
  FR_VECT_8U = 11 , FR_VECT_1U = 12
}
enum  data_types_type {
  FR_VECT_C = 0 , FR_VECT_2S = 1 , FR_VECT_8R = 2 , FR_VECT_4R = 3 ,
  FR_VECT_4S = 4 , FR_VECT_8S = 5 , FR_VECT_8C = 6 , FR_VECT_16C = 7 ,
  FR_VECT_STRING = 8 , FR_VECT_2U = 9 , FR_VECT_4U = 10 , FR_VECT_8U = 11 ,
  FR_VECT_1U = 12 , FR_VECT_C = 0 , FR_VECT_2S = 1 , FR_VECT_8R = 2 ,
  FR_VECT_4R = 3 , FR_VECT_4S = 4 , FR_VECT_8S = 5 , FR_VECT_8C = 6 ,
  FR_VECT_16C = 7 , FR_VECT_STRING = 8 , FR_VECT_2U = 9 , FR_VECT_4U = 10 ,
  FR_VECT_8U = 11 , FR_VECT_1U = 12
}
typedef std::string name_type
typedef std::string name_type
typedef std::string unit_y_type
typedef std::string unit_y_type
typedef FR_VECT_COMPRESS_TYPE compress_type
typedef FR_VECT_COMPRESS_TYPE compress_type
typedef FR_VECT_COMPRESSION_LEVEL_TYPE compression_level_type
typedef FR_VECT_COMPRESSION_LEVEL_TYPE compression_level_type
typedef FR_VECT_TYPE_TYPE type_type
typedef FR_VECT_TYPE_TYPE type_type
typedef FR_VECT_NDATA_TYPE nData_type
typedef FR_VECT_NDATA_TYPE nData_type
typedef FR_VECT_NBYTES_TYPE nBytes_type
typedef FR_VECT_NBYTES_TYPE nBytes_type
typedef FR_VECT_NDIM_TYPE nDim_type
typedef FR_VECT_NDIM_TYPE nDim_type
typedef boost::shared_array< CHAR_U > data_type
typedef boost::shared_array< CHAR_U > data_type
typedef data_type::element_type data_element_type
typedef data_type::element_type data_element_type
typedef data_element_typedata_pointer_type
typedef data_element_typedata_pointer_type
typedef const data_element_typedata_const_pointer_type
typedef const data_element_typedata_const_pointer_type
typedef std::vector< Dimensiondimension_container_type
typedef std::vector< Dimensiondimension_container_type
typedef FR_VECT_N_DATA_VALID n_data_valid_type
typedef FR_VECT_N_DATA_VALID n_data_valid_type
typedef FR_VECT_DATA_VALID_COMP_SCHEME data_valid_comp_scheme_type
typedef FR_VECT_DATA_VALID_COMP_SCHEME data_valid_comp_scheme_type
typedef FR_VECT_N_DATA_VALID_COMP_BYTES n_data_valid_comp_bytes_type
typedef FR_VECT_N_DATA_VALID_COMP_BYTES n_data_valid_comp_bytes_type
typedef boost::shared_array< CHAR_U > data_valid_type
typedef boost::shared_array< CHAR_U > data_valid_type
typedef INT_4U nData_v3_type
typedef INT_4U nData_v3_type
typedef INT_4U nBytes_v3_type
typedef INT_4U nBytes_v3_type
typedef const char *const struct_name_type
typedef const char *const struct_name_type
typedef const char *const struct_desc_type
typedef const char *const struct_desc_type
typedef INT_2U const struct_id_type
typedef INT_2U const struct_id_type
typedef INT_4U cmn_compression_scheme_type
typedef INT_4U cmn_compression_scheme_type
typedef INT_2U cmn_compression_level_type
typedef INT_2U cmn_compression_level_type
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
typedef IStream istream_type
typedef IStream istream_type
typedef OStream ostream_type
typedef OStream ostream_type

Public Member Functions

 ClassicIO ()
virtual Common::FrameSpec::ObjectCloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 ClassicIO ()
virtual Common::FrameSpec::ObjectCloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
bool operator== (const Common::FrameSpec::Object &Obj) const
virtual Compression::compression_base_type Compression () const
virtual Compression::compression_base_type Compression () const
virtual void CompressData (INT_4U Scheme, INT_2U Level)
virtual void CompressData (INT_4U Scheme, INT_2U Level)
const name_typeGetName () const
 Retrieve the channel name.
const name_typeGetName () const
 Retrieve the channel name.
compress_type GetCompress () const
 Retrieve the compression algorithm number.
compress_type GetCompress () const
 Retrieve the compression algorithm number.
type_type GetType () const
 Retrieve the vector class.
type_type GetType () const
 Retrieve the vector class.
size_t GetTypeSize () const
size_t GetTypeSize () const
nBytes_type GetNBytes () const
 Retrieve the number of bytes in the compressed vector.
nBytes_type GetNBytes () const
 Retrieve the number of bytes in the compressed vector.
nData_type GetNData () const
 Retrieve the number of sample elements in data series.
nData_type GetNData () const
 Retrieve the number of sample elements in data series.
nData_type GetNDataValid () const
 Retrieve the number of sample elements in data valid series.
nData_type GetNDataValid () const
 Retrieve the number of sample elements in data valid series.
nBytes_type GetNDataValidBytes () const
 Retrieve the number of bytes in the compressed dataValid vector.
nBytes_type GetNDataValidBytes () const
 Retrieve the number of bytes in the compressed dataValid vector.
data_type GetData () const
 Retrieve the pointer to the data.
data_type GetData () const
 Retrieve the pointer to the data.
data_valid_type GetDataValid ()
 Retrieve the pointer to the data.
data_valid_type GetDataValid ()
 Retrieve the pointer to the data.
data_valid_type GetDataValidRaw ()
 Retrieve the pointer to the data.
data_valid_type GetDataValidRaw ()
 Retrieve the pointer to the data.
const CHAR_U * GetDataValidUncompressed (data_valid_type &Expanded)
 Retrieve the pointer to the data.
const CHAR_U * GetDataValidUncompressed (data_valid_type &Expanded)
 Retrieve the pointer to the data.
compress_type GetDataValidCompress () const
 Retrieve the dataValid compression algorithm number.
compress_type GetDataValidCompress () const
 Retrieve the dataValid compression algorithm number.
data_type GetDataRaw () const
 Retrieve the pointer to the compressed data.
data_type GetDataRaw ()
 Retrieve the pointer to the compressed data.
data_type GetDataRaw () const
 Retrieve the pointer to the compressed data.
data_type GetDataRaw ()
 Retrieve the pointer to the compressed data.
data_type GetDataUncompressed ()
 Retrieve the pointer to the uncompressed data.
const CHAR_U * GetDataUncompressed (data_type &Expanded) const
 Retrieve the pointer to the uncompressed data.
data_type GetDataUncompressed ()
 Retrieve the pointer to the uncompressed data.
const CHAR_U * GetDataUncompressed (data_type &Expanded) const
 Retrieve the pointer to the uncompressed data.
nDim_type GetNDim () const
 Retrieve the number of dimensions.
nDim_type GetNDim () const
 Retrieve the number of dimensions.
const DimensionGetDim (nDim_type Offset) const
 Retrieve the Nth dimension.
DimensionGetDim (nDim_type Offset)
 Retrieve the Nth dimension.
const DimensionGetDim (nDim_type Offset) const
 Retrieve the Nth dimension.
DimensionGetDim (nDim_type Offset)
 Retrieve the Nth dimension.
dimension_container_typeGetDims ()
 Retrieve all the dimension information.
dimension_container_typeGetDims ()
 Retrieve all the dimension information.
const unit_y_typeGetUnitY () const
 Retrieve the description of how to interpret each element.
const unit_y_typeGetUnitY () const
 Retrieve the description of how to interpret each element.
void Compress (compression_scheme_type Scheme, int Level)
void Compress (compression_scheme_type Scheme, int Level)
void Uncompress ()
 Expand compressed data.
void Uncompress ()
 Expand compressed data.
void MimeData (const std::string &MimeType, void *Data, nBytes_type DataSize)
 Set the current FrVect with the MIME data.
void MimeData (const std::string &MimeType, void *Data, nBytes_type DataSize)
 Set the current FrVect with the MIME data.
void SetName (const name_type &Name)
 Establish the channel name.
void SetName (const name_type &Name)
 Establish the channel name.
void SetUnitY (const unit_y_type &UnitY)
 Set the description of how to interpret each element.
void SetUnitY (const unit_y_type &UnitY)
 Set the description of how to interpret each element.
void SetNData (nData_type NData)
void SetNData (nData_type NData)
void SetDataValid (const CHAR_U *DataValid, n_data_valid_type NDataValid, data_valid_comp_scheme_type Compression=RAW)
 Store data valid information.
void SetDataValid (const CHAR_U *DataValid, n_data_valid_type NDataValid, data_valid_comp_scheme_type Compression=RAW)
 Store data valid information.
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
virtual void Write (ostream_type &Stream) const
 Write object to the stream.

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
static const Common::DescriptionStructDescription ()
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
static const Common::DescriptionStructDescription ()
static data_type DataAlloc (type_type Type, const Dimension *Dims, const nDim_type NDim=1)
 Allocate a block of memory suitable for storing data.
static data_type DataAlloc (type_type Type, nData_type NData)
 Allocate a block of memory suitable for storing data.
static data_type DataAlloc (type_type Type, const Dimension *Dims, const nDim_type NDim=1)
 Allocate a block of memory suitable for storing data.
static data_type DataAlloc (type_type Type, nData_type NData)
 Allocate a block of memory suitable for storing data.
static size_t GetTypeSize (type_type Type)
 Get size of single data point of particular size.
static size_t GetTypeSize (type_type Type)
 Get size of single data point of particular size.
template<class T>
static type_type GetDataType ()
template<class T>
static type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
template<>
Data::type_type GetDataType ()
static struct_name_type FrameSpecName ()
static struct_name_type FrameSpecName ()
static struct_name_type StructName ()
static struct_name_type StructName ()
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.

Static Public Attributes

static const constexpr int DEFAULT_GZIP_LEVEL = 6
static struct_name_type struct_name
static struct_desc_type struct_desc
static struct_id_type struct_id

Protected Types

typedef STRING io_name_type
typedef STRING io_unit_y_type
typedef STRING io_name_type
typedef STRING io_unit_y_type
enum  {
  MODE_RAW = BIGENDIAN_RAW , MODE_GZIP = BIGENDIAN_GZIP , MODE_DIFF_GZIP = BIGENDIAN_DIFF_GZIP , MODE_ZERO_SUPPRESS = BIGENDIAN_ZERO_SUPPRESS ,
  MODE_ZSTD = BIGENDIAN_ZSTD , MODE_DIFF_ZSTD = BIGENDIAN_DIFF_GZIP
}
enum  { MODE_BIGENDIAN = BIGENDIAN_RAW , MODE_LITTLEENDIAN = LITTLEENDIAN_RAW , MODE_HOSTENDIAN = RAW }
enum  {
  MODE_RAW = BIGENDIAN_RAW , MODE_GZIP = BIGENDIAN_GZIP , MODE_DIFF_GZIP = BIGENDIAN_DIFF_GZIP , MODE_ZERO_SUPPRESS = BIGENDIAN_ZERO_SUPPRESS ,
  MODE_ZSTD = BIGENDIAN_ZSTD , MODE_DIFF_ZSTD = BIGENDIAN_DIFF_GZIP
}
enum  { MODE_BIGENDIAN = BIGENDIAN_RAW , MODE_LITTLEENDIAN = LITTLEENDIAN_RAW , MODE_HOSTENDIAN = RAW }

Protected Member Functions

virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the integrity of the object.
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
virtual const char * ObjectStructName () const
 The name structure name of this object.
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 The data structure description.
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
virtual FrameCPP::cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
virtual self_typepCreate (istream_type &Stream) const
 Stream constructor.
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the integrity of the object.
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
virtual const char * ObjectStructName () const
 The name structure name of this object.
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 The data structure description.
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
virtual FrameCPP::cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
virtual self_typepCreate (istream_type &Stream) const
 Stream constructor.
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
template<typename NDATA_T, typename NBYTES_T, typename DATA_T>
void compress_block (type_type BlockType, INT_4U Scheme, int Level, NDATA_T &NData, NBYTES_T &NBytes, DATA_T &Block, compress_type &CompressionScheme)
 Compress a block data.
template<typename NDATA_T, typename NBYTES_T, typename DATA_T>
void compress_block (type_type BlockType, INT_4U Scheme, int Level, NDATA_T &NData, NBYTES_T &NBytes, DATA_T &Block, compress_type &CompressionScheme)
 Compress a block data.
template<typename DATA_T, typename NBYTES_T>
void uncompress_block (compress_type &CompressionScheme, NBYTES_T &NBytes, DATA_T &Block)
template<typename DATA_T, typename NBYTES_T>
void uncompress_block (compress_type &CompressionScheme, NBYTES_T &NBytes, DATA_T &Block)
void data_alloc (nBytes_type NBytes)
void data_alloc (nBytes_type NBytes)
void data_copy (data_const_pointer_type Data, nBytes_type NBytes)
void data_copy (data_const_pointer_type Data, nBytes_type NBytes)
void expandToBuffer (data_type &Dest, nBytes_type &DestNBytes) const
void expandToBuffer (data_type &Dest, nBytes_type &DestNBytes) const
void expandToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, const INT_4U SourceByteOrder, Compression::output_type &Dest, INT_8U &DestNBytes) const
void compressToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::compress_type_reverse_mapping &CompressionReverseMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, Compression::output_type &Dest, INT_8U &DestNBytes, INT_4U &DestCompressionMode, const INT_4U Level) const
void compressToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::compress_type_reverse_mapping &CompressionReverseMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, Compression::output_type &Dest, INT_8U &DestNBytes, INT_4U &DestCompressionMode, const INT_4U Level) const

Static Protected Member Functions

static FrameCPP::Compression::compress_type_mappingcompress_type_map ()
static FrameCPP::Compression::compress_type_mappingcompress_type_map ()
static FrameCPP::Compression::compress_type_reverse_mappingcompress_type_reverse_map ()
static FrameCPP::Compression::compress_type_reverse_mappingcompress_type_reverse_map ()
static FrameCPP::Compression::data_type_mappingdata_type_map ()
static FrameCPP::Compression::data_type_mappingdata_type_map ()

Protected Attributes

data_definition_type m_data

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type

Private Member Functions

FrameCPP::cmn_streamsize_type Bytes (const std::vector< Dimension > &Dims, const Common::StreamBase &Stream)
virtual ObjectCreate () const
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
virtual ObjectCreate () const
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual

Static Private Member Functions

template<typename OBJECT_TYPE>
static FrameCPP::cmn_streamsize_type Bytes (const OBJECT_TYPE &Object, const Common::StreamBase &Stream)
template<typename OBJECT_TYPE>
static FrameCPP::cmn_streamsize_type Bytes (const OBJECT_TYPE &Object, const Common::StreamBase &Stream)

Private Attributes

ChecksumType m_chkSum
 Structure checksum.

Static Private Attributes

static const constexpr char * MIME_TYPE_KEYWORD = "MIMETYPE"
static const constexpr FrameCPP::Version_9::Dimension::nx_type MIME_TYPE_NX = 0
static const constexpr FrameCPP::Version_9::Dimension::dx_type MIME_TYPE_DX = 0
static const constexpr FrameCPP::Version_9::Dimension::startX_type MIME_TYPE_START_X = 0

Member Typedef Documentation

◆ cmn_compression_level_type [1/2]

typedef INT_2U FrameCPP::Common::FrVect::cmn_compression_level_type
inherited

◆ cmn_compression_level_type [2/2]

typedef INT_2U FrameCPP::Common::FrVect::cmn_compression_level_type
inherited

◆ cmn_compression_scheme_type [1/2]

typedef INT_4U FrameCPP::Common::FrVect::cmn_compression_scheme_type
inherited

◆ cmn_compression_scheme_type [2/2]

typedef INT_4U FrameCPP::Common::FrVect::cmn_compression_scheme_type
inherited

◆ compress_type [1/2]

◆ compress_type [2/2]

◆ compression_level_type [1/2]

◆ compression_level_type [2/2]

◆ data_const_pointer_type [1/2]

◆ data_const_pointer_type [2/2]

◆ data_element_type [1/2]

typedef data_type::element_type FrameCPP::Version_9::FrVectImpl::Data::data_element_type
inherited

◆ data_element_type [2/2]

typedef data_type::element_type FrameCPP::Version_9::FrVectImpl::Data::data_element_type
inherited

◆ data_pointer_type [1/2]

◆ data_pointer_type [2/2]

◆ data_type [1/2]

typedef boost::shared_array< CHAR_U > FrameCPP::Version_9::FrVectImpl::Data::data_type
inherited

◆ data_type [2/2]

typedef boost::shared_array< CHAR_U > FrameCPP::Version_9::FrVectImpl::Data::data_type
inherited

◆ data_valid_comp_scheme_type [1/2]

◆ data_valid_comp_scheme_type [2/2]

◆ data_valid_type [1/2]

typedef boost::shared_array< CHAR_U > FrameCPP::Version_9::FrVectImpl::Data::data_valid_type
inherited

◆ data_valid_type [2/2]

typedef boost::shared_array< CHAR_U > FrameCPP::Version_9::FrVectImpl::Data::data_valid_type
inherited

◆ dimension_container_type [1/2]

◆ dimension_container_type [2/2]

◆ io_name_type [1/2]

template<typename T>
typedef STRING FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::io_name_type
protected

◆ io_name_type [2/2]

template<typename T>
typedef STRING FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::io_name_type
protected

◆ io_unit_y_type [1/2]

template<typename T>
typedef STRING FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::io_unit_y_type
protected

◆ io_unit_y_type [2/2]

template<typename T>
typedef STRING FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::io_unit_y_type
protected

◆ istream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ n_data_valid_comp_bytes_type [1/2]

◆ n_data_valid_comp_bytes_type [2/2]

◆ n_data_valid_type [1/2]

◆ n_data_valid_type [2/2]

◆ name_type [1/2]

typedef std::string FrameCPP::Version_9::FrVectImpl::Data::name_type
inherited

◆ name_type [2/2]

typedef std::string FrameCPP::Version_9::FrVectImpl::Data::name_type
inherited

◆ nBytes_type [1/2]

◆ nBytes_type [2/2]

◆ nBytes_v3_type [1/2]

◆ nBytes_v3_type [2/2]

◆ nData_type [1/2]

◆ nData_type [2/2]

◆ nData_v3_type [1/2]

◆ nData_v3_type [2/2]

◆ nDim_type [1/2]

◆ nDim_type [2/2]

◆ object_base_type

◆ object_type [1/2]

Object with checksum data.

◆ object_type [2/2]

Object with checksum data.

◆ ostream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ self_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ struct_desc_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_desc_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type [1/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_id_type [2/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ struct_name_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ type_type [1/2]

◆ type_type [2/2]

◆ unit_y_type [1/2]

◆ unit_y_type [2/2]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
MODE_BIGENDIAN 
MODE_LITTLEENDIAN 
MODE_HOSTENDIAN 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
MODE_RAW 
MODE_GZIP 
MODE_DIFF_GZIP 
MODE_ZERO_SUPPRESS 
MODE_ZSTD 
MODE_DIFF_ZSTD 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
MODE_RAW 
MODE_GZIP 
MODE_DIFF_GZIP 
MODE_ZERO_SUPPRESS 
MODE_ZSTD 
MODE_DIFF_ZSTD 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
MODE_BIGENDIAN 
MODE_LITTLEENDIAN 
MODE_HOSTENDIAN 

◆ compression_scheme_type [1/2]

Enumerator
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
NONE 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
NONE 

◆ compression_scheme_type [2/2]

Enumerator
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
NONE 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
NONE 

◆ data_types_type [1/2]

Enumerator
FR_VECT_C 
FR_VECT_2S 
FR_VECT_8R 
FR_VECT_4R 
FR_VECT_4S 
FR_VECT_8S 
FR_VECT_8C 
FR_VECT_16C 
FR_VECT_STRING 
FR_VECT_2U 
FR_VECT_4U 
FR_VECT_8U 
FR_VECT_1U 
FR_VECT_C 
FR_VECT_2S 
FR_VECT_8R 
FR_VECT_4R 
FR_VECT_4S 
FR_VECT_8S 
FR_VECT_8C 
FR_VECT_16C 
FR_VECT_STRING 
FR_VECT_2U 
FR_VECT_4U 
FR_VECT_8U 
FR_VECT_1U 

◆ data_types_type [2/2]

Enumerator
FR_VECT_C 
FR_VECT_2S 
FR_VECT_8R 
FR_VECT_4R 
FR_VECT_4S 
FR_VECT_8S 
FR_VECT_8C 
FR_VECT_16C 
FR_VECT_STRING 
FR_VECT_2U 
FR_VECT_4U 
FR_VECT_8U 
FR_VECT_1U 
FR_VECT_C 
FR_VECT_2S 
FR_VECT_8R 
FR_VECT_4R 
FR_VECT_4S 
FR_VECT_8S 
FR_VECT_8C 
FR_VECT_16C 
FR_VECT_STRING 
FR_VECT_2U 
FR_VECT_4U 
FR_VECT_8U 
FR_VECT_1U 

Constructor & Destructor Documentation

◆ ClassicIO() [1/2]

template<typename T>
FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [2/2]

template<typename T>
FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::ClassicIO ( )
inline

Member Function Documentation

◆ Bytes() [1/4]

template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Bytes() [2/4]

template<typename T>
template<typename OBJECT_TYPE>
FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::Bytes ( const OBJECT_TYPE & Object,
const Common::StreamBase & Stream )
staticprivate

◆ Bytes() [3/4]

template<typename T>
template<typename OBJECT_TYPE>
FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::Bytes ( const OBJECT_TYPE & Object,
const Common::StreamBase & Stream )
staticprivate

◆ Bytes() [4/4]

FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< FrameCPP::Version_9::FrVect >::Bytes< std::vector< Dimension > > ( const std::vector< Dimension > & Dims,
const Common::StreamBase & Stream )
private

◆ CheckSumDataClass() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType, typename ChecksumType>
const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType, typename ChecksumType>
const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CloneCompressed() [1/2]

template<typename T>
virtual Common::FrameSpec::Object * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::CloneCompressed ( cmn_compression_scheme_type Scheme,
cmn_compression_level_type Level ) const
inlinevirtual

◆ CloneCompressed() [2/2]

template<typename T>
virtual Common::FrameSpec::Object * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::CloneCompressed ( cmn_compression_scheme_type Scheme,
cmn_compression_level_type Level ) const
inlinevirtual

◆ Compress() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::Compress ( compression_scheme_type Scheme,
int Level )
inlineinherited

◆ Compress() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::Compress ( compression_scheme_type Scheme,
int Level )
inlineinherited

◆ compress_block() [1/2]

template<typename NDATA_T, typename NBYTES_T, typename DATA_T>
void FrameCPP::Version_9::FrVectImpl::Data::compress_block ( type_type BlockType,
INT_4U Scheme,
int Level,
NDATA_T & NData,
NBYTES_T & NBytes,
DATA_T & Block,
compress_type & CompressionScheme )
inlineprotectedinherited

Compress a block data.

Parameters
[in]SchemeDesired compression method
[in,out]NDataBlock of data to be compressed. The compressed buffer will be stored in this variable. @para[in,out] NBytes On input, the number of bytes in NData. On output, the number of bytes in the compressed NData buffer.
[in,out]Block,Blockof data to be compressed. Upon output, the compressed form of the block
[out]CompressionSchemeThe compression scheme

◆ compress_block() [2/2]

template<typename NDATA_T, typename NBYTES_T, typename DATA_T>
void FrameCPP::Version_9::FrVectImpl::Data::compress_block ( type_type BlockType,
INT_4U Scheme,
int Level,
NDATA_T & NData,
NBYTES_T & NBytes,
DATA_T & Block,
compress_type & CompressionScheme )
inlineprotectedinherited

Compress a block data.

Parameters
[in]SchemeDesired compression method
[in,out]NDataBlock of data to be compressed. The compressed buffer will be stored in this variable. @para[in,out] NBytes On input, the number of bytes in NData. On output, the number of bytes in the compressed NData buffer.
[in,out]Block,Blockof data to be compressed. Upon output, the compressed form of the block
[out]CompressionSchemeThe compression scheme

◆ compress_type_map() [1/2]

FrameCPP::Compression::compress_type_mapping & FrameCPP::Version_9::FrVectImpl::Data::compress_type_map ( )
inlinestaticprotectedinherited

◆ compress_type_map() [2/2]

FrameCPP::Compression::compress_type_mapping & FrameCPP::Version_9::FrVectImpl::Data::compress_type_map ( )
inlinestaticprotectedinherited

◆ compress_type_reverse_map() [1/2]

FrameCPP::Compression::compress_type_reverse_mapping & FrameCPP::Version_9::FrVectImpl::Data::compress_type_reverse_map ( )
inlinestaticprotectedinherited

◆ compress_type_reverse_map() [2/2]

FrameCPP::Compression::compress_type_reverse_mapping & FrameCPP::Version_9::FrVectImpl::Data::compress_type_reverse_map ( )
inlinestaticprotectedinherited

◆ CompressData() [1/2]

virtual void FrameCPP::Version_9::FrVectImpl::Data::CompressData ( INT_4U Scheme,
INT_2U Level )
inlinevirtualinherited

◆ CompressData() [2/2]

virtual void FrameCPP::Version_9::FrVectImpl::Data::CompressData ( INT_4U Scheme,
INT_2U Level )
inlinevirtualinherited

◆ Compression() [1/2]

virtual Compression::compression_base_type FrameCPP::Version_9::FrVectImpl::Data::Compression ( ) const
inlinevirtualinherited

◆ Compression() [2/2]

virtual Compression::compression_base_type FrameCPP::Version_9::FrVectImpl::Data::Compression ( ) const
inlinevirtualinherited

◆ compressToBuffer() [1/2]

void FrameCPP::Common::FrVect::compressToBuffer ( const Compression::compress_type_mapping & CompressionMapping,
const Compression::compress_type_reverse_mapping & CompressionReverseMapping,
const Compression::data_type_mapping & DataTypeMapping,
const INT_4U DataType,
const INT_8U NData,
const CHAR_U * Source,
const INT_8U SourceNBytes,
const INT_4U SourceCompressionMode,
Compression::output_type & Dest,
INT_8U & DestNBytes,
INT_4U & DestCompressionMode,
const INT_4U Level ) const
protectedinherited

◆ compressToBuffer() [2/2]

void FrameCPP::Common::FrVect::compressToBuffer ( const Compression::compress_type_mapping & CompressionMapping,
const Compression::compress_type_reverse_mapping & CompressionReverseMapping,
const Compression::data_type_mapping & DataTypeMapping,
const INT_4U DataType,
const INT_8U NData,
const CHAR_U * Source,
const INT_8U SourceNBytes,
const INT_4U SourceCompressionMode,
Compression::output_type & Dest,
INT_8U & DestNBytes,
INT_4U & DestCompressionMode,
const INT_4U Level ) const
protectedinherited

◆ Create() [1/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [4/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [5/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ data_alloc() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::data_alloc ( nBytes_type NBytes)
inlineprotectedinherited

◆ data_alloc() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::data_alloc ( nBytes_type NBytes)
inlineprotectedinherited

◆ data_copy() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::data_copy ( data_const_pointer_type Data,
nBytes_type NBytes )
inlineprotectedinherited

◆ data_copy() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::data_copy ( data_const_pointer_type Data,
nBytes_type NBytes )
inlineprotectedinherited

◆ data_type_map() [1/2]

FrameCPP::Compression::data_type_mapping & FrameCPP::Version_9::FrVectImpl::Data::data_type_map ( )
inlinestaticprotectedinherited

◆ data_type_map() [2/2]

FrameCPP::Compression::data_type_mapping & FrameCPP::Version_9::FrVectImpl::Data::data_type_map ( )
inlinestaticprotectedinherited

◆ DataAlloc() [1/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::DataAlloc ( type_type Type,
const Dimension * Dims,
const nDim_type NDim = 1 )
inlinestaticinherited

Allocate a block of memory suitable for storing data.

Parameters
[in]TypeThe type of data that is to be stored in the buffer.
[in]DimsInformation concearning each dimension of the array of data to be stored in the buffer.
[in]NDimThe number of dimensions of data to be stored in the buffer
Returns
Upon successful allocation, an appropriated sized buffer is returned. An expection is thrown for all error conditions.

◆ DataAlloc() [2/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::DataAlloc ( type_type Type,
const Dimension * Dims,
const nDim_type NDim = 1 )
inlinestaticinherited

Allocate a block of memory suitable for storing data.

Parameters
[in]TypeThe type of data that is to be stored in the buffer.
[in]DimsInformation concearning each dimension of the array of data to be stored in the buffer.
[in]NDimThe number of dimensions of data to be stored in the buffer
Returns
Upon successful allocation, an appropriated sized buffer is returned. An expection is thrown for all error conditions.

◆ DataAlloc() [3/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::DataAlloc ( type_type Type,
nData_type NData )
inlinestaticinherited

Allocate a block of memory suitable for storing data.

Parameters
[in]TypeThe type of data that is to be stored in the buffer.
[in]DimsInformation concearning each dimension of the array of data to be stored in the buffer.
[in]NDimThe number of dimensions of data to be stored in the buffer
Returns
Upon successful allocation, an appropriated sized buffer is returned. An expection is thrown for all error conditions.

◆ DataAlloc() [4/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::DataAlloc ( type_type Type,
nData_type NData )
inlinestaticinherited

Allocate a block of memory suitable for storing data.

Parameters
[in]TypeThe type of data that is to be stored in the buffer.
[in]DimsInformation concearning each dimension of the array of data to be stored in the buffer.
[in]NDimThe number of dimensions of data to be stored in the buffer
Returns
Upon successful allocation, an appropriated sized buffer is returned. An expection is thrown for all error conditions.

◆ demote() [1/2]

template<typename T>
virtual demote_ret_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ demote() [2/2]

template<typename T>
virtual demote_ret_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ expandToBuffer() [1/3]

void FrameCPP::Common::FrVect::expandToBuffer ( const Compression::compress_type_mapping & CompressionMapping,
const Compression::data_type_mapping & DataTypeMapping,
const INT_4U DataType,
const INT_8U NData,
const CHAR_U * Source,
const INT_8U SourceNBytes,
const INT_4U SourceCompressionMode,
const INT_4U SourceByteOrder,
Compression::output_type & Dest,
INT_8U & DestNBytes ) const
protectedinherited

◆ expandToBuffer() [2/3]

void FrameCPP::Version_9::FrVectImpl::Data::expandToBuffer ( data_type & Dest,
nBytes_type & DestNBytes ) const
inlineprotectedinherited

◆ expandToBuffer() [3/3]

void FrameCPP::Version_9::FrVectImpl::Data::expandToBuffer ( data_type & Dest,
nBytes_type & DestNBytes ) const
inlineprotectedinherited

◆ FrameSpecDescription() [1/2]

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/2]

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/2]

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/2]

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetCompress() [1/2]

compress_type FrameCPP::Version_9::FrVectImpl::Data::GetCompress ( ) const
inlineinherited

Retrieve the compression algorithm number.

Returns
The compression algorithm number.

◆ GetCompress() [2/2]

compress_type FrameCPP::Version_9::FrVectImpl::Data::GetCompress ( ) const
inlineinherited

Retrieve the compression algorithm number.

Returns
The compression algorithm number.

◆ GetData() [1/2]

data_type FrameCPP::Version_9::FrVectImpl::Data::GetData ( ) const
inlineinherited

Retrieve the pointer to the data.

Return a pointer to the data being managed by the FrVect structure.

Returns
The pointer to the data.
Note
This will expand the data if it is currently compressed.
See also
GetDataRaw, GetDataUncompressed

◆ GetData() [2/2]

data_type FrameCPP::Version_9::FrVectImpl::Data::GetData ( ) const
inlineinherited

Retrieve the pointer to the data.

Return a pointer to the data being managed by the FrVect structure.

Returns
The pointer to the data.
Note
This will expand the data if it is currently compressed.
See also
GetDataRaw, GetDataUncompressed

◆ GetDataRaw() [1/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::GetDataRaw ( )
inlineinherited

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataRaw() [2/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::GetDataRaw ( )
inlineinherited

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataRaw() [3/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::GetDataRaw ( ) const
inlineinherited

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataRaw() [4/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::GetDataRaw ( ) const
inlineinherited

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataType() [1/14]

template<class T>
type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [2/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [3/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [4/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [5/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [6/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [7/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [8/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [9/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [10/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [11/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [12/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [13/14]

template<>
Data::type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [14/14]

template<class T>
type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataUncompressed() [1/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::GetDataUncompressed ( )
inlineinherited

Retrieve the pointer to the uncompressed data.

Returns
The pointer to the uncompressed data.

◆ GetDataUncompressed() [2/4]

data_type FrameCPP::Version_9::FrVectImpl::Data::GetDataUncompressed ( )
inlineinherited

Retrieve the pointer to the uncompressed data.

Returns
The pointer to the uncompressed data.

◆ GetDataUncompressed() [3/4]

const CHAR_U * FrameCPP::Version_9::FrVectImpl::Data::GetDataUncompressed ( data_type & Expanded) const
inlineinherited

Retrieve the pointer to the uncompressed data.

Parameters
[in]ExpandedBuffer into which the data is expanded.
Returns
The pointer to the uncompressed data.

◆ GetDataUncompressed() [4/4]

const CHAR_U * FrameCPP::Version_9::FrVectImpl::Data::GetDataUncompressed ( data_type & Expanded) const
inlineinherited

Retrieve the pointer to the uncompressed data.

Parameters
[in]ExpandedBuffer into which the data is expanded.
Returns
The pointer to the uncompressed data.

◆ GetDataValid() [1/2]

data_valid_type FrameCPP::Version_9::FrVectImpl::Data::GetDataValid ( )
inlineinherited

Retrieve the pointer to the data.

Return a pointer to the data valid being managed by the FrVect structure.

Returns
The pointer to the data valid.
Note
This will expand the data valid if it is currently compressed.
See also
GetDataValidRaw

◆ GetDataValid() [2/2]

data_valid_type FrameCPP::Version_9::FrVectImpl::Data::GetDataValid ( )
inlineinherited

Retrieve the pointer to the data.

Return a pointer to the data valid being managed by the FrVect structure.

Returns
The pointer to the data valid.
Note
This will expand the data valid if it is currently compressed.
See also
GetDataValidRaw

◆ GetDataValidCompress() [1/2]

compress_type FrameCPP::Version_9::FrVectImpl::Data::GetDataValidCompress ( ) const
inlineinherited

Retrieve the dataValid compression algorithm number.

Returns
The compression algorithm number.

◆ GetDataValidCompress() [2/2]

compress_type FrameCPP::Version_9::FrVectImpl::Data::GetDataValidCompress ( ) const
inlineinherited

Retrieve the dataValid compression algorithm number.

Returns
The compression algorithm number.

◆ GetDataValidRaw() [1/2]

data_valid_type FrameCPP::Version_9::FrVectImpl::Data::GetDataValidRaw ( )
inlineinherited

Retrieve the pointer to the data.

Return a pointer to the data valid being managed by the FrVect structure.

Returns
The pointer to the data valid.
See also
GetDataValid

◆ GetDataValidRaw() [2/2]

data_valid_type FrameCPP::Version_9::FrVectImpl::Data::GetDataValidRaw ( )
inlineinherited

Retrieve the pointer to the data.

Return a pointer to the data valid being managed by the FrVect structure.

Returns
The pointer to the data valid.
See also
GetDataValid

◆ GetDataValidUncompressed() [1/2]

const CHAR_U * FrameCPP::Version_9::FrVectImpl::Data::GetDataValidUncompressed ( data_valid_type & Expanded)
inlineinherited

Retrieve the pointer to the data.

Return a pointer to the data valid being managed by the FrVect structure.

Returns
The pointer to the data valid.
Note
This will expand the data valid if it is currently compressed.
See also
GetDataValidRaw

◆ GetDataValidUncompressed() [2/2]

const CHAR_U * FrameCPP::Version_9::FrVectImpl::Data::GetDataValidUncompressed ( data_valid_type & Expanded)
inlineinherited

Retrieve the pointer to the data.

Return a pointer to the data valid being managed by the FrVect structure.

Returns
The pointer to the data valid.
Note
This will expand the data valid if it is currently compressed.
See also
GetDataValidRaw

◆ GetDescription() [1/2]

template<typename T>
virtual const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::GetDescription ( ostream_type & Stream) const
inlineprotectedvirtual

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

◆ GetDescription() [2/2]

template<typename T>
virtual const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::GetDescription ( ostream_type & Stream) const
inlineprotectedvirtual

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

◆ GetDim() [1/4]

Dimension & FrameCPP::Version_9::FrVectImpl::Data::GetDim ( nDim_type Offset)
inlineinherited

Retrieve the Nth dimension.

Parameters
[in]OffsetIndex for desired dimension
Returns
The Nth dimension
Todo
Throw exception if value out of range

◆ GetDim() [2/4]

Dimension & FrameCPP::Version_9::FrVectImpl::Data::GetDim ( nDim_type Offset)
inlineinherited

Retrieve the Nth dimension.

Parameters
[in]OffsetIndex for desired dimension
Returns
The Nth dimension
Todo
Throw exception if value out of range

◆ GetDim() [3/4]

const Dimension & FrameCPP::Version_9::FrVectImpl::Data::GetDim ( nDim_type Offset) const
inlineinherited

Retrieve the Nth dimension.

Parameters
[in]OffsetIndex for desired dimension
Returns
The Nth dimension
Todo
Throw exception if value out of range

◆ GetDim() [4/4]

const Dimension & FrameCPP::Version_9::FrVectImpl::Data::GetDim ( nDim_type Offset) const
inlineinherited

Retrieve the Nth dimension.

Parameters
[in]OffsetIndex for desired dimension
Returns
The Nth dimension
Todo
Throw exception if value out of range

◆ GetDims() [1/2]

dimension_container_type & FrameCPP::Version_9::FrVectImpl::Data::GetDims ( )
inlineinherited

Retrieve all the dimension information.

Returns
The colletion of dimension data

◆ GetDims() [2/2]

dimension_container_type & FrameCPP::Version_9::FrVectImpl::Data::GetDims ( )
inlineinherited

Retrieve all the dimension information.

Returns
The colletion of dimension data

◆ GetName() [1/2]

const name_type & FrameCPP::Version_9::FrVectImpl::Data::GetName ( ) const
inlineinherited

Retrieve the channel name.

Returns
The channel name

◆ GetName() [2/2]

const name_type & FrameCPP::Version_9::FrVectImpl::Data::GetName ( ) const
inlineinherited

Retrieve the channel name.

Returns
The channel name

◆ GetNBytes() [1/2]

nBytes_type FrameCPP::Version_9::FrVectImpl::Data::GetNBytes ( ) const
inlineinherited

Retrieve the number of bytes in the compressed vector.

Returns
The number of bytes in the compressed vector.

◆ GetNBytes() [2/2]

nBytes_type FrameCPP::Version_9::FrVectImpl::Data::GetNBytes ( ) const
inlineinherited

Retrieve the number of bytes in the compressed vector.

Returns
The number of bytes in the compressed vector.

◆ GetNData() [1/2]

nData_type FrameCPP::Version_9::FrVectImpl::Data::GetNData ( ) const
inlineinherited

Retrieve the number of sample elements in data series.

Returns
The number of sample elements in data series.

◆ GetNData() [2/2]

nData_type FrameCPP::Version_9::FrVectImpl::Data::GetNData ( ) const
inlineinherited

Retrieve the number of sample elements in data series.

Returns
The number of sample elements in data series.

◆ GetNDataValid() [1/2]

nData_type FrameCPP::Version_9::FrVectImpl::Data::GetNDataValid ( ) const
inlineinherited

Retrieve the number of sample elements in data valid series.

Returns
The number of sample elements in data series.

◆ GetNDataValid() [2/2]

nData_type FrameCPP::Version_9::FrVectImpl::Data::GetNDataValid ( ) const
inlineinherited

Retrieve the number of sample elements in data valid series.

Returns
The number of sample elements in data series.

◆ GetNDataValidBytes() [1/2]

nBytes_type FrameCPP::Version_9::FrVectImpl::Data::GetNDataValidBytes ( ) const
inlineinherited

Retrieve the number of bytes in the compressed dataValid vector.

Returns
The number of bytes in the compressed dataValid vector.

◆ GetNDataValidBytes() [2/2]

nBytes_type FrameCPP::Version_9::FrVectImpl::Data::GetNDataValidBytes ( ) const
inlineinherited

Retrieve the number of bytes in the compressed dataValid vector.

Returns
The number of bytes in the compressed dataValid vector.

◆ GetNDim() [1/2]

nDim_type FrameCPP::Version_9::FrVectImpl::Data::GetNDim ( ) const
inlineinherited

Retrieve the number of dimensions.

Returns
The number of dimensions

◆ GetNDim() [2/2]

nDim_type FrameCPP::Version_9::FrVectImpl::Data::GetNDim ( ) const
inlineinherited

Retrieve the number of dimensions.

Returns
The number of dimensions

◆ GetType() [1/2]

type_type FrameCPP::Version_9::FrVectImpl::Data::GetType ( ) const
inlineinherited

Retrieve the vector class.

Returns
The vector class.

◆ GetType() [2/2]

type_type FrameCPP::Version_9::FrVectImpl::Data::GetType ( ) const
inlineinherited

Retrieve the vector class.

Returns
The vector class.

◆ GetTypeSize() [1/4]

size_t FrameCPP::Version_9::FrVectImpl::Data::GetTypeSize ( ) const
inlineinherited

◆ GetTypeSize() [2/4]

size_t FrameCPP::Version_9::FrVectImpl::Data::GetTypeSize ( ) const
inlineinherited

◆ GetTypeSize() [3/4]

size_t FrameCPP::Version_9::FrVectImpl::Data::GetTypeSize ( type_type Type)
inlinestaticinherited

Get size of single data point of particular size.

Parameters
[in]TypeData type ID.
Returns
Data size.

◆ GetTypeSize() [4/4]

size_t FrameCPP::Version_9::FrVectImpl::Data::GetTypeSize ( type_type Type)
inlinestaticinherited

Get size of single data point of particular size.

Parameters
[in]TypeData type ID.
Returns
Data size.

◆ GetUnitY() [1/2]

const unit_y_type & FrameCPP::Version_9::FrVectImpl::Data::GetUnitY ( ) const
inlineinherited

Retrieve the description of how to interpret each element.

Returns
The description of how to interpret each element

◆ GetUnitY() [2/2]

const unit_y_type & FrameCPP::Version_9::FrVectImpl::Data::GetUnitY ( ) const
inlineinherited

Retrieve the description of how to interpret each element.

Returns
The description of how to interpret each element

◆ MimeData() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::MimeData ( const std::string & MimeType,
void * Data,
nBytes_type DataSize )
inlineinherited

Set the current FrVect with the MIME data.

◆ MimeData() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::MimeData ( const std::string & MimeType,
void * Data,
nBytes_type DataSize )
inlineinherited

Set the current FrVect with the MIME data.

◆ ObjectStructName() [1/2]

template<typename T>
virtual const char * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::ObjectStructName ( ) const
inlineprotectedvirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/2]

template<typename T>
virtual const char * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::ObjectStructName ( ) const
inlineprotectedvirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ operator==() [1/3]

◆ operator==() [2/3]

template<typename T>
virtual bool FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/3]

template<typename T>
virtual bool FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

template<typename T>
virtual FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pBytes() [2/2]

template<typename T>
virtual FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [1/2]

template<typename T>
virtual self_type * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [2/2]

template<typename T>
virtual self_type * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ Promote() [1/2]

template<typename T>
promote_ret_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

template<typename T>
promote_ret_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

template<typename T>
virtual promote_ret_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ promote() [2/2]

template<typename T>
virtual promote_ret_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ pWrite() [1/2]

template<typename T>
virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pWrite() [2/2]

template<typename T>
virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ SetDataValid() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::SetDataValid ( const CHAR_U * DataValid,
n_data_valid_type NDataValid,
data_valid_comp_scheme_type Compression = RAW )
inlineinherited

Store data valid information.

Parameters
[in]

◆ SetDataValid() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::SetDataValid ( const CHAR_U * DataValid,
n_data_valid_type NDataValid,
data_valid_comp_scheme_type Compression = RAW )
inlineinherited

Store data valid information.

Parameters
[in]

◆ SetName() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::SetName ( const name_type & Name)
inlineinherited

Establish the channel name.

Assign a new value for the channel name.

Parameters
[in]NameThe channel name

◆ SetName() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::SetName ( const name_type & Name)
inlineinherited

Establish the channel name.

Assign a new value for the channel name.

Parameters
[in]NameThe channel name

◆ SetNData() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::SetNData ( nData_type NData)
inlineinherited

◆ SetNData() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::SetNData ( nData_type NData)
inlineinherited

◆ SetUnitY() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::SetUnitY ( const unit_y_type & UnitY)
inlineinherited

Set the description of how to interpret each element.

Assign a new value for the channel name.

Parameters
[in]UnitYNew description
Returns
The description of how to interpret each element

◆ SetUnitY() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::SetUnitY ( const unit_y_type & UnitY)
inlineinherited

Set the description of how to interpret each element.

Assign a new value for the channel name.

Parameters
[in]UnitYNew description
Returns
The description of how to interpret each element

◆ StructDescription() [1/2]

template<typename T>
const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

◆ StructDescription() [2/2]

template<typename T>
const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

◆ StructName() [1/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [2/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ Uncompress() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::Uncompress ( )
inlineinherited

Expand compressed data.

In general, uncompressing follows three steps:

1) Gunzip the data. 2) Fix byte-ordering. 3) Integrate.

Depending upon the compression type and byte-ordering differences, not all of these steps are needed.

◆ Uncompress() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::Uncompress ( )
inlineinherited

Expand compressed data.

In general, uncompressing follows three steps:

1) Gunzip the data. 2) Fix byte-ordering. 3) Integrate.

Depending upon the compression type and byte-ordering differences, not all of these steps are needed.

◆ uncompress_block() [1/2]

template<typename DATA_T, typename NBYTES_T>
void FrameCPP::Version_9::FrVectImpl::Data::uncompress_block ( compress_type & CompressionScheme,
NBYTES_T & NBytes,
DATA_T & Block )
inlineprotectedinherited

◆ uncompress_block() [2/2]

template<typename DATA_T, typename NBYTES_T>
void FrameCPP::Version_9::FrVectImpl::Data::uncompress_block ( compress_type & CompressionScheme,
NBYTES_T & NBytes,
DATA_T & Block )
inlineprotectedinherited

◆ VerifyObject() [1/2]

template<typename T>
virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::VerifyObject ( Common::Verify & Verifier,
Common::IFrameStream & Stream ) const
inlineprotectedvirtual

Verify the integrity of the object.

Parameters
VerifierThe handle to the Verify object used to store data that needs to be accumulated before being processed.
StreamThe input stream from which the object was created.
Remarks
Upon failure, this method thows an exception.

◆ VerifyObject() [2/2]

template<typename T>
virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::VerifyObject ( Common::Verify & Verifier,
Common::IFrameStream & Stream ) const
inlineprotectedvirtual

Verify the integrity of the object.

Parameters
VerifierThe handle to the Verify object used to store data that needs to be accumulated before being processed.
StreamThe input stream from which the object was created.
Remarks
Upon failure, this method thows an exception.

◆ Write() [1/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ DEFAULT_GZIP_LEVEL

const constexpr int FrameCPP::Version_9::FrVectImpl::Data::DEFAULT_GZIP_LEVEL = 6
staticconstexprinherited

◆ m_chkSum

template<typename ObjectType, typename ChecksumType>
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_data

data_definition_type FrameCPP::Version_9::FrVectImpl::Data::m_data
protectedinherited

◆ MIME_TYPE_DX

const constexpr FrameCPP::Version_9::Dimension::dx_type FrameCPP::Version_9::FrVectImpl::Data::MIME_TYPE_DX = 0
staticconstexprprivateinherited

◆ MIME_TYPE_KEYWORD

const constexpr char * FrameCPP::Version_9::FrVectImpl::Data::MIME_TYPE_KEYWORD = "MIMETYPE"
staticconstexprprivateinherited

◆ MIME_TYPE_NX

const constexpr FrameCPP::Version_9::Dimension::nx_type FrameCPP::Version_9::FrVectImpl::Data::MIME_TYPE_NX = 0
staticconstexprprivateinherited

◆ MIME_TYPE_START_X

const constexpr FrameCPP::Version_9::Dimension::startX_type FrameCPP::Version_9::FrVectImpl::Data::MIME_TYPE_START_X = 0
staticconstexprprivateinherited

◆ struct_desc

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/impl/FrVectClassicIO.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/impl/FrVectClassicIO.hh