ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrVectImpl::Data::data_definition_type Struct Reference

#include <FrVectData.hh>

Public Member Functions

 data_definition_type ()
 
 data_definition_type (const std::string &n, INT_2U t, const byte_order_type byte_order, nDim_type ndim, const Dimension *dims, const std::string &unit)
 
void copy_core (const data_definition_type &Source)
 
void set (const std::string &n, INT_2U t, const byte_order_type byte_order, nDim_type ndim, const Dimension *dims, const std::string &unit)
 
bool operator== (const data_definition_type &RHS) const
 
 data_definition_type ()
 
 data_definition_type (const std::string &n, INT_2U t, const byte_order_type byte_order, nDim_type ndim, const Dimension *dims, const std::string &unit)
 
void copy_core (const data_definition_type &Source)
 
void set (const std::string &n, INT_2U t, const byte_order_type byte_order, nDim_type ndim, const Dimension *dims, const std::string &unit)
 
bool operator== (const data_definition_type &RHS) const
 

Static Public Member Functions

static FrameCPP::cmn_streamsize_type calc_nData (const std::vector< Dimension > &Dimensions)
 
static FrameCPP::cmn_streamsize_type calc_nData (const std::vector< Dimension > &Dimensions)
 

Public Attributes

name_type name
 
compress_type compress
 Compression algorithm number.
 
type_type type
 Vector class.
 
nData_type nData
 Number of sample elements in data series.
 
nBytes_type nBytes
 Number of bytes in the compressed vector.
 
data_type data
 Compressed data series.
 
dimension_container_type dimension
 Dimension data for data series.
 
unit_y_type unitY
 
n_data_valid_type nDataValid = 0
 Number of bytes in the data valid vector.
 
data_valid_comp_scheme_type dataValidCompScheme = RAW
 Compression scheme used by dataValid vector.
 
n_data_valid_comp_bytes_type nDataValidCompBytes = 0
 Number of bytes in the compressed data valid vector.
 
data_valid_type dataValid
 

Constructor & Destructor Documentation

◆ data_definition_type() [1/4]

FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::data_definition_type ( )
inline

◆ data_definition_type() [2/4]

FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::data_definition_type ( const std::string & n,
INT_2U t,
const byte_order_type byte_order,
nDim_type ndim,
const Dimension * dims,
const std::string & unit )
inline

◆ data_definition_type() [3/4]

FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::data_definition_type ( )
inline

◆ data_definition_type() [4/4]

FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::data_definition_type ( const std::string & n,
INT_2U t,
const byte_order_type byte_order,
nDim_type ndim,
const Dimension * dims,
const std::string & unit )
inline

Member Function Documentation

◆ calc_nData() [1/2]

static FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::calc_nData ( const std::vector< Dimension > & Dimensions)
inlinestatic

◆ calc_nData() [2/2]

static FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::calc_nData ( const std::vector< Dimension > & Dimensions)
inlinestatic

◆ copy_core() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::copy_core ( const data_definition_type & Source)
inline

◆ copy_core() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::copy_core ( const data_definition_type & Source)
inline

◆ operator==() [1/2]

bool FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::operator== ( const data_definition_type & RHS) const
inline

◆ operator==() [2/2]

bool FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::operator== ( const data_definition_type & RHS) const
inline

◆ set() [1/2]

void FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::set ( const std::string & n,
INT_2U t,
const byte_order_type byte_order,
nDim_type ndim,
const Dimension * dims,
const std::string & unit )
inline

◆ set() [2/2]

void FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::set ( const std::string & n,
INT_2U t,
const byte_order_type byte_order,
nDim_type ndim,
const Dimension * dims,
const std::string & unit )
inline

Member Data Documentation

◆ compress

compress_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::compress

Compression algorithm number.

◆ data

data_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::data

Compressed data series.

◆ dataValid

data_valid_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::dataValid

This is an array of dataValid value covering the span of the FrVect.data. A value of 0 in teh array signifies the corresponding block of data is valid. A non-zero value in the array signifies data as suspect

◆ dataValidCompScheme

data_valid_comp_scheme_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::dataValidCompScheme = RAW

Compression scheme used by dataValid vector.

◆ dimension

dimension_container_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::dimension

Dimension data for data series.

◆ name

name_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::name

Channel name.

Note
Not required to be unique.

◆ nBytes

nBytes_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::nBytes

Number of bytes in the compressed vector.

◆ nData

nData_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::nData

Number of sample elements in data series.

◆ nDataValid

n_data_valid_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::nDataValid = 0

Number of bytes in the data valid vector.

◆ nDataValidCompBytes

n_data_valid_comp_bytes_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::nDataValidCompBytes = 0

Number of bytes in the compressed data valid vector.

◆ type

type_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::type

Vector class.

◆ unitY

unit_y_type FrameCPP::Version_9::FrVectImpl::Data::data_definition_type::unitY

String describing how to interpret the value of each element.


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