#include <FrVectSerialIO.hh>
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_type & | GetName () const |
Retrieve the channel name. | |
const name_type & | GetName () 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 Dimension & | GetDim (nDim_type Offset) const |
Retrieve the Nth dimension. | |
Dimension & | GetDim (nDim_type Offset) |
Retrieve the Nth dimension. | |
const Dimension & | GetDim (nDim_type Offset) const |
Retrieve the Nth dimension. | |
Dimension & | GetDim (nDim_type Offset) |
Retrieve the Nth dimension. | |
dimension_container_type & | GetDims () |
Retrieve all the dimension information. | |
dimension_container_type & | GetDims () |
Retrieve all the dimension information. | |
const unit_y_type & | GetUnitY () const |
Retrieve the description of how to interpret each element. | |
const unit_y_type & | GetUnitY () 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 FrameSpec::Object * | CloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const =0 |
virtual FrameSpec::Object * | CloneCompressed (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, 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 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 = 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 | |
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_mapping & | compress_type_map () |
static FrameCPP::Compression::compress_type_mapping & | compress_type_map () |
static FrameCPP::Compression::compress_type_reverse_mapping & | compress_type_reverse_map () |
static FrameCPP::Compression::compress_type_reverse_mapping & | compress_type_reverse_map () |
static FrameCPP::Compression::data_type_mapping & | data_type_map () |
static FrameCPP::Compression::data_type_mapping & | data_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_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 |
Friends | |
class | boost::serialization::access |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
protectedinherited |
|
inherited |
|
inherited |
|
inline |
|
inline |
|
pure virtualinherited |
Implemented in FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.
|
pure virtualinherited |
Implemented in FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.
|
inlineinherited |
|
inlineinherited |
|
inlineprotectedinherited |
Compress a block data.
[in] | Scheme | Desired compression method |
[in,out] | NData | Block 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,Block | of data to be compressed. Upon output, the compressed form of the block |
[out] | CompressionScheme | The compression scheme |
|
inlineprotectedinherited |
Compress a block data.
[in] | Scheme | Desired compression method |
[in,out] | NData | Block 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,Block | of data to be compressed. Upon output, the compressed form of the block |
[out] | CompressionScheme | The compression scheme |
|
inlinestaticprotectedinherited |
|
inlinestaticprotectedinherited |
|
inlinestaticprotectedinherited |
|
inlinestaticprotectedinherited |
|
inlinevirtualinherited |
Implements FrameCPP::Common::FrVect.
|
inlinevirtualinherited |
Implements FrameCPP::Common::FrVect.
|
inlinevirtualinherited |
Implements FrameCPP::Common::FrVect.
|
inlinevirtualinherited |
Implements FrameCPP::Common::FrVect.
|
protectedinherited |
|
protectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlinestaticprotectedinherited |
|
inlinestaticprotectedinherited |
|
inlinestaticinherited |
Allocate a block of memory suitable for storing data.
[in] | Type | The type of data that is to be stored in the buffer. |
[in] | Dims | Information concearning each dimension of the array of data to be stored in the buffer. |
[in] | NDim | The number of dimensions of data to be stored in the buffer |
|
inlinestaticinherited |
Allocate a block of memory suitable for storing data.
[in] | Type | The type of data that is to be stored in the buffer. |
[in] | Dims | Information concearning each dimension of the array of data to be stored in the buffer. |
[in] | NDim | The number of dimensions of data to be stored in the buffer |
|
inlinestaticinherited |
Allocate a block of memory suitable for storing data.
[in] | Type | The type of data that is to be stored in the buffer. |
[in] | Dims | Information concearning each dimension of the array of data to be stored in the buffer. |
[in] | NDim | The number of dimensions of data to be stored in the buffer |
|
inlinestaticinherited |
Allocate a block of memory suitable for storing data.
[in] | Type | The type of data that is to be stored in the buffer. |
[in] | Dims | Information concearning each dimension of the array of data to be stored in the buffer. |
[in] | NDim | The number of dimensions of data to be stored in the buffer |
|
protectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inlineinherited |
Retrieve the compression algorithm number.
|
inlineinherited |
Retrieve the compression algorithm number.
|
inlineinherited |
Retrieve the pointer to the data.
Return a pointer to the data being managed by the FrVect structure.
|
inlineinherited |
Retrieve the pointer to the data.
Return a pointer to the data being managed by the FrVect structure.
|
inlineinherited |
Retrieve the pointer to the compressed data.
|
inlineinherited |
Retrieve the pointer to the compressed data.
|
inlineinherited |
Retrieve the pointer to the compressed data.
|
inlineinherited |
Retrieve the pointer to the compressed data.
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
inlineinherited |
Retrieve the pointer to the uncompressed data.
|
inlineinherited |
Retrieve the pointer to the uncompressed data.
|
inlineinherited |
Retrieve the pointer to the uncompressed data.
[in] | Expanded | Buffer into which the data is expanded. |
|
inlineinherited |
Retrieve the pointer to the uncompressed data.
[in] | Expanded | Buffer into which the data is expanded. |
|
inlineinherited |
Retrieve the pointer to the data.
Return a pointer to the data valid being managed by the FrVect structure.
|
inlineinherited |
Retrieve the pointer to the data.
Return a pointer to the data valid being managed by the FrVect structure.
|
inlineinherited |
Retrieve the dataValid compression algorithm number.
|
inlineinherited |
Retrieve the dataValid compression algorithm number.
|
inlineinherited |
Retrieve the pointer to the data.
Return a pointer to the data valid being managed by the FrVect structure.
|
inlineinherited |
Retrieve the pointer to the data.
Return a pointer to the data valid being managed by the FrVect structure.
|
inlineinherited |
Retrieve the pointer to the data.
Return a pointer to the data valid being managed by the FrVect structure.
|
inlineinherited |
Retrieve the pointer to the data.
Return a pointer to the data valid being managed by the FrVect structure.
Retrieve the Nth dimension.
[in] | Offset | Index for desired dimension |
Retrieve the Nth dimension.
[in] | Offset | Index for desired dimension |
|
inlineinherited |
Retrieve the Nth dimension.
[in] | Offset | Index for desired dimension |
|
inlineinherited |
Retrieve the Nth dimension.
[in] | Offset | Index for desired dimension |
|
inlineinherited |
Retrieve all the dimension information.
|
inlineinherited |
Retrieve all the dimension information.
|
inlineinherited |
Retrieve the channel name.
|
inlineinherited |
Retrieve the channel name.
|
inlineinherited |
Retrieve the number of bytes in the compressed vector.
|
inlineinherited |
Retrieve the number of bytes in the compressed vector.
|
inlineinherited |
Retrieve the number of sample elements in data series.
|
inlineinherited |
Retrieve the number of sample elements in data series.
|
inlineinherited |
Retrieve the number of sample elements in data valid series.
|
inlineinherited |
Retrieve the number of sample elements in data valid series.
|
inlineinherited |
Retrieve the number of bytes in the compressed dataValid vector.
|
inlineinherited |
Retrieve the number of bytes in the compressed dataValid vector.
|
inlineinherited |
Retrieve the number of dimensions.
|
inlineinherited |
Retrieve the number of dimensions.
|
inlineinherited |
Retrieve the vector class.
|
inlineinherited |
Retrieve the vector class.
|
inlineinherited |
|
inlineinherited |
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inlineinherited |
Retrieve the description of how to interpret each element.
|
inlineinherited |
Retrieve the description of how to interpret each element.
|
inlineprivate |
|
inlineprivate |
|
inlineinherited |
Set the current FrVect with the MIME data.
|
inlineinherited |
Set the current FrVect with the MIME data.
|
inlineprivate |
|
inlineprivate |
|
inlineinherited |
Store data valid information.
[in] |
|
inlineinherited |
Store data valid information.
[in] |
|
inlineinherited |
Establish the channel name.
Assign a new value for the channel name.
[in] | Name | The channel name |
|
inlineinherited |
Establish the channel name.
Assign a new value for the channel name.
[in] | Name | The channel name |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Set the description of how to interpret each element.
Assign a new value for the channel name.
[in] | UnitY | New description |
|
inlineinherited |
Set the description of how to interpret each element.
Assign a new value for the channel name.
[in] | UnitY | New description |
|
inlinestaticinherited |
|
inlinestaticinherited |
|
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.
|
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.
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
friend |
|
staticconstexprinherited |
|
protectedinherited |
|
staticconstexprprivateinherited |
|
staticconstexprprivateinherited |
|
staticconstexprprivateinherited |
|
staticconstexprprivateinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |