ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrVectImpl::SerialIO< FR_VECT_T > Class Template Referenceabstract

#include <FrVectSerialIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrVectImpl::SerialIO< FR_VECT_T >:
Collaboration diagram for FrameCPP::Version_8::FrVectImpl::SerialIO< FR_VECT_T >:

Public Types

enum  compression_scheme_type {
  CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) ,
  CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , ZERO_SUPPRESS_OTHERWISE_GZIP = 6 ,
  BEST_COMPRESSION = 9 , ZERO_SUPPRESS_SHORT = ZERO_SUPPRESS_WORD_2 , ZERO_SUPPRESS_INT_FLOAT = ZERO_SUPPRESS_WORD_4 , NONE = RAW ,
  CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) ,
  CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , ZERO_SUPPRESS_OTHERWISE_GZIP = 6 ,
  BEST_COMPRESSION = 9 , ZERO_SUPPRESS_SHORT = ZERO_SUPPRESS_WORD_2 , ZERO_SUPPRESS_INT_FLOAT = ZERO_SUPPRESS_WORD_4 , NONE = RAW
}
 
enum  compression_scheme_type {
  CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) ,
  CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , ZERO_SUPPRESS_OTHERWISE_GZIP = 6 ,
  BEST_COMPRESSION = 9 , ZERO_SUPPRESS_SHORT = ZERO_SUPPRESS_WORD_2 , ZERO_SUPPRESS_INT_FLOAT = ZERO_SUPPRESS_WORD_4 , NONE = RAW ,
  CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) ,
  CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , CST_DECL =( RAW, 0 ) , ZERO_SUPPRESS_OTHERWISE_GZIP = 6 ,
  BEST_COMPRESSION = 9 , ZERO_SUPPRESS_SHORT = ZERO_SUPPRESS_WORD_2 , ZERO_SUPPRESS_INT_FLOAT = ZERO_SUPPRESS_WORD_4 , 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 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
 

Public Member Functions

 SerialIO ()
 
 SerialIO ()
 
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
 
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.
 
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.
 
data_type GetData () const
 Retrieve the pointer to the data.
 
data_type GetData () const
 Retrieve the pointer to the data.
 
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)
 
virtual FrameSpec::ObjectCloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const =0
 
virtual FrameSpec::ObjectCloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const =0
 

Static Public Member Functions

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, const Dimension *Dims, const nDim_type NDim=1)
 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 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

enum  {
  MODE_RAW = BIGENDIAN_RAW , MODE_GZIP = BIGENDIAN_GZIP , MODE_DIFF_GZIP = BIGENDIAN_DIFF_GZIP , MODE_ZERO_SUPPRESS_WORD_2 = BIGENDIAN_ZERO_SUPPRESS_WORD_2 ,
  MODE_ZERO_SUPPRESS_WORD_4 = BIGENDIAN_ZERO_SUPPRESS_WORD_4 , MODE_ZERO_SUPPRESS_WORD_8 = BIGENDIAN_ZERO_SUPPRESS_WORD_8
}
 
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_WORD_2 = BIGENDIAN_ZERO_SUPPRESS_WORD_2 ,
  MODE_ZERO_SUPPRESS_WORD_4 = BIGENDIAN_ZERO_SUPPRESS_WORD_4 , MODE_ZERO_SUPPRESS_WORD_8 = BIGENDIAN_ZERO_SUPPRESS_WORD_8
}
 
enum  { MODE_BIGENDIAN = BIGENDIAN_RAW , MODE_LITTLEENDIAN = LITTLEENDIAN_RAW , MODE_HOSTENDIAN = RAW }
 

Protected Member Functions

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 Member Functions

template<class Archive>
void save (Archive &ar, const unsigned int version) const
 
template<class Archive>
void load (Archive &ar, const unsigned int version)
 
template<class Archive>
void save (Archive &ar, const unsigned int version) const
 
template<class Archive>
void load (Archive &ar, const unsigned int version)
 

Static Private Attributes

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

Friends

class boost::serialization::access
 

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_8::FrVectImpl::Data::data_element_type
inherited

◆ data_element_type [2/2]

typedef data_type::element_type FrameCPP::Version_8::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_8::FrVectImpl::Data::data_type
inherited

◆ data_type [2/2]

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

◆ dimension_container_type [1/2]

◆ dimension_container_type [2/2]

◆ name_type [1/2]

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

◆ name_type [2/2]

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

◆ nBytes_type [1/2]

◆ nBytes_type [2/2]

◆ nData_type [1/2]

◆ nData_type [2/2]

◆ nDim_type [1/2]

◆ nDim_type [2/2]

◆ 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_WORD_2 
MODE_ZERO_SUPPRESS_WORD_4 
MODE_ZERO_SUPPRESS_WORD_8 

◆ 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_WORD_2 
MODE_ZERO_SUPPRESS_WORD_4 
MODE_ZERO_SUPPRESS_WORD_8 

◆ compression_scheme_type [1/2]

Enumerator
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_OTHERWISE_GZIP 
BEST_COMPRESSION 
ZERO_SUPPRESS_SHORT 
ZERO_SUPPRESS_INT_FLOAT 
NONE 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_OTHERWISE_GZIP 
BEST_COMPRESSION 
ZERO_SUPPRESS_SHORT 
ZERO_SUPPRESS_INT_FLOAT 
NONE 

◆ compression_scheme_type [2/2]

Enumerator
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_OTHERWISE_GZIP 
BEST_COMPRESSION 
ZERO_SUPPRESS_SHORT 
ZERO_SUPPRESS_INT_FLOAT 
NONE 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_OTHERWISE_GZIP 
BEST_COMPRESSION 
ZERO_SUPPRESS_SHORT 
ZERO_SUPPRESS_INT_FLOAT 
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

◆ SerialIO() [1/2]

template<typename FR_VECT_T>
FrameCPP::Version_8::FrVectImpl::SerialIO< FR_VECT_T >::SerialIO ( )
inline

◆ SerialIO() [2/2]

template<typename FR_VECT_T>
FrameCPP::Version_8::FrVectImpl::SerialIO< FR_VECT_T >::SerialIO ( )
inline

Member Function Documentation

◆ CloneCompressed() [1/2]

◆ CloneCompressed() [2/2]

◆ Compress() [1/2]

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

◆ Compress() [2/2]

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

◆ compress_type_map() [1/2]

static FrameCPP::Compression::compress_type_mapping & FrameCPP::Version_8::FrVectImpl::Data::compress_type_map ( )
inlinestaticprotectedinherited

◆ compress_type_map() [2/2]

static FrameCPP::Compression::compress_type_mapping & FrameCPP::Version_8::FrVectImpl::Data::compress_type_map ( )
inlinestaticprotectedinherited

◆ compress_type_reverse_map() [1/2]

static FrameCPP::Compression::compress_type_reverse_mapping & FrameCPP::Version_8::FrVectImpl::Data::compress_type_reverse_map ( )
inlinestaticprotectedinherited

◆ compress_type_reverse_map() [2/2]

static FrameCPP::Compression::compress_type_reverse_mapping & FrameCPP::Version_8::FrVectImpl::Data::compress_type_reverse_map ( )
inlinestaticprotectedinherited

◆ CompressData() [1/2]

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

◆ CompressData() [2/2]

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

◆ Compression() [1/2]

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

◆ Compression() [2/2]

virtual Compression::compression_base_type FrameCPP::Version_8::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

◆ data_alloc() [1/2]

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

◆ data_alloc() [2/2]

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

◆ data_copy() [1/2]

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

◆ data_copy() [2/2]

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

◆ data_type_map() [1/2]

static FrameCPP::Compression::data_type_mapping & FrameCPP::Version_8::FrVectImpl::Data::data_type_map ( )
inlinestaticprotectedinherited

◆ data_type_map() [2/2]

static FrameCPP::Compression::data_type_mapping & FrameCPP::Version_8::FrVectImpl::Data::data_type_map ( )
inlinestaticprotectedinherited

◆ DataAlloc() [1/2]

static data_type FrameCPP::Version_8::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/2]

static data_type FrameCPP::Version_8::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.

◆ 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_8::FrVectImpl::Data::expandToBuffer ( data_type & Dest,
nBytes_type & DestNBytes ) const
inlineprotectedinherited

◆ expandToBuffer() [3/3]

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

◆ FrameSpecDescription() [1/2]

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

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/2]

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

Return the dictionary name of the structure.

◆ FrameSpecId() [1/2]

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

Return the dictionary name of the structure.

◆ FrameSpecId() [2/2]

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

Return the dictionary name of the structure.

◆ FrameSpecName() [1/2]

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

◆ FrameSpecName() [2/2]

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

◆ GetCompress() [1/2]

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

Retrieve the compression algorithm number.

Returns
The compression algorithm number.

◆ GetCompress() [2/2]

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

Retrieve the compression algorithm number.

Returns
The compression algorithm number.

◆ GetData() [1/2]

data_type FrameCPP::Version_8::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_8::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_8::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_8::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_8::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_8::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>
static type_type FrameCPP::Version_8::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataType() [2/14]

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

◆ GetDataType() [3/14]

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

◆ GetDataType() [4/14]

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

◆ GetDataType() [5/14]

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

◆ GetDataType() [6/14]

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

◆ GetDataType() [7/14]

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

◆ GetDataType() [8/14]

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

◆ GetDataType() [9/14]

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

◆ GetDataType() [10/14]

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

◆ GetDataType() [11/14]

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

◆ GetDataType() [12/14]

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

◆ GetDataType() [13/14]

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

◆ GetDataType() [14/14]

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

◆ GetDataUncompressed() [1/4]

data_type FrameCPP::Version_8::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_8::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_8::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_8::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.

◆ GetDim() [1/4]

Dimension & FrameCPP::Version_8::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_8::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_8::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_8::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_8::FrVectImpl::Data::GetDims ( )
inlineinherited

Retrieve all the dimension information.

Returns
The colletion of dimension data

◆ GetDims() [2/2]

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

Retrieve all the dimension information.

Returns
The colletion of dimension data

◆ GetName() [1/2]

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

Retrieve the channel name.

Returns
The channel name

◆ GetName() [2/2]

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

Retrieve the channel name.

Returns
The channel name

◆ GetNBytes() [1/2]

nBytes_type FrameCPP::Version_8::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_8::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_8::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_8::FrVectImpl::Data::GetNData ( ) const
inlineinherited

Retrieve the number of sample elements in data series.

Returns
The number of sample elements in data series.

◆ GetNDim() [1/2]

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

Retrieve the number of dimensions.

Returns
The number of dimensions

◆ GetNDim() [2/2]

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

Retrieve the number of dimensions.

Returns
The number of dimensions

◆ GetType() [1/2]

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

Retrieve the vector class.

Returns
The vector class.

◆ GetType() [2/2]

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

Retrieve the vector class.

Returns
The vector class.

◆ GetTypeSize() [1/4]

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

◆ GetTypeSize() [2/4]

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

◆ GetTypeSize() [3/4]

static size_t FrameCPP::Version_8::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]

static size_t FrameCPP::Version_8::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_8::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_8::FrVectImpl::Data::GetUnitY ( ) const
inlineinherited

Retrieve the description of how to interpret each element.

Returns
The description of how to interpret each element

◆ load() [1/2]

template<typename FR_VECT_T>
template<class Archive>
void FrameCPP::Version_8::FrVectImpl::SerialIO< FR_VECT_T >::load ( Archive & ar,
const unsigned int version )
inlineprivate

◆ load() [2/2]

template<typename FR_VECT_T>
template<class Archive>
void FrameCPP::Version_8::FrVectImpl::SerialIO< FR_VECT_T >::load ( Archive & ar,
const unsigned int version )
inlineprivate

◆ MimeData() [1/2]

void FrameCPP::Version_8::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_8::FrVectImpl::Data::MimeData ( const std::string & MimeType,
void * Data,
nBytes_type DataSize )
inlineinherited

Set the current FrVect with the MIME data.

◆ save() [1/2]

template<typename FR_VECT_T>
template<class Archive>
void FrameCPP::Version_8::FrVectImpl::SerialIO< FR_VECT_T >::save ( Archive & ar,
const unsigned int version ) const
inlineprivate

◆ save() [2/2]

template<typename FR_VECT_T>
template<class Archive>
void FrameCPP::Version_8::FrVectImpl::SerialIO< FR_VECT_T >::save ( Archive & ar,
const unsigned int version ) const
inlineprivate

◆ SetName() [1/2]

void FrameCPP::Version_8::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_8::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_8::FrVectImpl::Data::SetNData ( nData_type NData)
inlineinherited

◆ SetNData() [2/2]

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

◆ SetUnitY() [1/2]

void FrameCPP::Version_8::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_8::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

◆ StructName() [1/2]

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

◆ StructName() [2/2]

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

◆ Uncompress() [1/2]

void FrameCPP::Version_8::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_8::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.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<typename FR_VECT_T>
boost::serialization::access
friend

Member Data Documentation

◆ DEFAULT_GZIP_LEVEL

static const constexpr int FrameCPP::Version_8::FrVectImpl::Data::DEFAULT_GZIP_LEVEL = 6
staticconstexprinherited

◆ m_data

data_definition_type FrameCPP::Version_8::FrVectImpl::Data::m_data
protectedinherited

◆ MIME_TYPE_DX

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

◆ MIME_TYPE_KEYWORD

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

◆ MIME_TYPE_NX

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

◆ MIME_TYPE_START_X

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

◆ struct_desc

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

◆ struct_id

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

◆ struct_name

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

The documentation for this class was generated from the following files: