Vector Data Structure Definition. More...

#include <FrVect.hh>

Inheritance diagram for FrameCPP::Version_9::FrVect:

Collaboration diagram for FrameCPP::Version_9::FrVect:

Public Types
typedef std::unique_ptr< FrVect >	subfrvect_type

typedef std::unique_ptr< FrVect >	subfrvect_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

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 }

typedef std::string	name_type

typedef std::string	unit_y_type

typedef FR_VECT_COMPRESS_TYPE	compress_type

typedef FR_VECT_COMPRESSION_LEVEL_TYPE	compression_level_type

typedef FR_VECT_TYPE_TYPE	type_type

typedef FR_VECT_NDATA_TYPE	nData_type

typedef FR_VECT_NBYTES_TYPE	nBytes_type

typedef FR_VECT_NDIM_TYPE	nDim_type

typedef boost::shared_array< CHAR_U >	data_type

typedef data_type::element_type	data_element_type

typedef data_element_type *	data_pointer_type

typedef const data_element_type *	data_const_pointer_type

typedef std::vector< Dimension >	dimension_container_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_N_DATA_VALID_COMP_BYTES	n_data_valid_comp_bytes_type

typedef boost::shared_array< CHAR_U >	data_valid_type

typedef INT_4U	nData_v3_type

typedef INT_4U	nBytes_v3_type

typedef const char *const	struct_name_type

typedef const char *const	struct_desc_type

typedef INT_2U const	struct_id_type

typedef INT_4U	cmn_compression_scheme_type

typedef INT_2U	cmn_compression_level_type

Public Member Functions
const name_type &	GetName () const
	Retrieve the name of message, error flag, or alarm state.

	FrVect ()
	Default constructor.

	FrVect (const FrVect &vect)
	Copy Constructor.

	FrVect (const std::string &name, type_type type, nDim_type nDim, const Dimension dims, const byte_order_type byte_order=BYTE_ORDER_HOST, const void data=0, const std::string &unitY="")
	Constructor.

	FrVect (const std::string &name, compress_type Compress, type_type type, nDim_type nDim, const Dimension *dims, nData_type NData, nBytes_type NBytes, data_type Data, const std::string &unitY="")

	FrVect (const std::string &Name, type_type Type, nDim_type NDim, const Dimension *Dims, const std::string &UnitY)
	Constructor.

template<class T>
	FrVect (const std::string &name, nDim_type nDim=1, const Dimension dims=0, const T data=0, const std::string &unitY="")

template<class T>
	FrVect (const std::string &name, nDim_type nDim=1, const Dimension dims=0, T data=0, const std::string &unitY="")

	FrVect (const Previous::FrVect &Source, stream_base_type *Stream)
	Promotion Constructor.

virtual	~FrVect ()
	Destructor.

subfrvect_type	SubFrVect (INT_4U Start, INT_4U Stop) const
	Request a subset of the data.

bool	operator== (const FrVect &RHS) const
	equality operator

bool	operator!= (const FrVect &RHS) const
	inequality operator

FrVect &	operator+= (const FrVect &RHS)
	Concatinate with another FrAdcData.

FrVect &	Merge (const FrVect &RHS)
	Merge with another FrAdcData.

const name_type &	GetName () const
	Retrieve the name of message, error flag, or alarm state.

	FrVect ()
	Default constructor.

	FrVect (const FrVect &vect)
	Copy Constructor.

	FrVect (const std::string &name, type_type type, nDim_type nDim, const Dimension dims, const byte_order_type byte_order=BYTE_ORDER_HOST, const void data=0, const std::string &unitY="")
	Constructor.

	FrVect (const std::string &name, compress_type Compress, type_type type, nDim_type nDim, const Dimension *dims, nData_type NData, nBytes_type NBytes, data_type Data, const std::string &unitY="")

	FrVect (const std::string &Name, type_type Type, nDim_type NDim, const Dimension *Dims, const std::string &UnitY)
	Constructor.

template<class T>
	FrVect (const std::string &name, nDim_type nDim=1, const Dimension dims=0, const T data=0, const std::string &unitY="")

template<class T>
	FrVect (const std::string &name, nDim_type nDim=1, const Dimension dims=0, T data=0, const std::string &unitY="")

	FrVect (const Previous::FrVect &Source, stream_base_type *Stream)
	Promotion Constructor.

virtual	~FrVect ()
	Destructor.

subfrvect_type	SubFrVect (INT_4U Start, INT_4U Stop) const
	Request a subset of the data.

bool	operator== (const FrVect &RHS) const
	equality operator

bool	operator!= (const FrVect &RHS) const
	inequality operator

FrVect &	operator+= (const FrVect &RHS)
	Concatinate with another FrAdcData.

FrVect &	Merge (const FrVect &RHS)
	Merge with another FrAdcData.

bool	operator== (const Common::FrameSpec::Object &Obj) const

virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.

virtual Common::FrameSpec::Object *	CloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const

virtual Common::FrameSpec::Object *	CloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (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.

virtual Compression::compression_base_type	Compression () const

virtual void	CompressData (INT_4U Scheme, INT_2U Level)

compress_type	GetCompress () const
	Retrieve the compression algorithm number.

type_type	GetType () const
	Retrieve the vector class.

size_t	GetTypeSize () const

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

data_type	GetData () const
	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.

const CHAR_U *	GetDataValidUncompressed (data_valid_type &Expanded)
	Retrieve the pointer to the data.

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

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.

const unit_y_type &	GetUnitY () const
	Retrieve the description of how to interpret each element.

void	Compress (compression_scheme_type Scheme, int Level)

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

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 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::Description *	StructDescription ()

static const Common::Description *	StructDescription ()

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

template<class T>
static type_type	GetDataType ()

static struct_name_type	FrameSpecName ()

static struct_name_type	StructName ()

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 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_name_type

typedef STRING	io_unit_y_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 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 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 char *	ObjectStructName () const
	The name structure name of this object.

virtual const Common::Description *	GetDescription (ostream_type &Stream) const
	The data structure description.

virtual const Common::Description *	GetDescription (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 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 FrameCPP::cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.

virtual self_type *	pCreate (istream_type &Stream) const
	Stream constructor.

virtual self_type *	pCreate (istream_type &Stream) const
	Stream constructor.

virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream.

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 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_copy (data_const_pointer_type Data, nBytes_type NBytes)

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

Static Protected Member Functions
static FrameCPP::Compression::compress_type_mapping &	compress_type_map ()

static FrameCPP::Compression::compress_type_reverse_mapping &	compress_type_reverse_map ()

static FrameCPP::Compression::data_type_mapping &	data_type_map ()

Protected Attributes
data_definition_type	m_data

Private Types
typedef ObjectWithChecksum< Common::FrameSpec::Object >	object_type
	Object with checksum data.

typedef ObjectWithChecksum< Common::FrameSpec::Object >	object_type
	Object with checksum data.

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >	object_base_type

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >	object_base_type

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >	object_base_type

Private Member Functions
FrameCPP::cmn_streamsize_type	Bytes (const std::vector< Dimension > &Dims, const Common::StreamBase &Stream)

FrameCPP::cmn_streamsize_type	Bytes (const std::vector< Dimension > &Dims, const Common::StreamBase &Stream)

virtual Object *	Create () const

virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

virtual Object *	Create () const

virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

void	save (Archive &ar, const unsigned int version) const

void	save (Archive &ar, const unsigned int version) const

void	load (Archive &ar, const unsigned int version)

void	load (Archive &ar, const unsigned int version)

Static Private Member Functions
static FrameCPP::cmn_streamsize_type	Bytes (const OBJECT_TYPE &Object, const Common::StreamBase &Stream)

static FrameCPP::cmn_streamsize_type	Bytes (const OBJECT_TYPE &Object, const Common::StreamBase &Stream)

Private Attributes
ChecksumType	m_chkSum
	Structure checksum.

Detailed Description

Vector Data Structure Definition.

Member Typedef Documentation

◆ cmn_compression_level_type

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

inherited

◆ cmn_compression_scheme_type

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

inherited

◆ compress_type

typedef FR_VECT_COMPRESS_TYPE FrameCPP::Version_9::FrVectImpl::Data::compress_type

inherited

◆ compression_level_type

typedef FR_VECT_COMPRESSION_LEVEL_TYPE FrameCPP::Version_9::FrVectImpl::Data::compression_level_type

inherited

◆ data_const_pointer_type

typedef const data_element_type* FrameCPP::Version_9::FrVectImpl::Data::data_const_pointer_type

inherited

◆ data_element_type

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

inherited

◆ data_pointer_type

typedef data_element_type* FrameCPP::Version_9::FrVectImpl::Data::data_pointer_type

inherited

◆ data_type

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

inherited

◆ data_valid_comp_scheme_type

typedef FR_VECT_DATA_VALID_COMP_SCHEME FrameCPP::Version_9::FrVectImpl::Data::data_valid_comp_scheme_type

inherited

◆ data_valid_type

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

inherited

◆ dimension_container_type

typedef std::vector< Dimension > FrameCPP::Version_9::FrVectImpl::Data::dimension_container_type

inherited

◆ io_name_type [1/2]

typedef STRING FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::io_name_type

protectedinherited

◆ io_name_type [2/2]

typedef STRING FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::io_name_type

protectedinherited

◆ io_unit_y_type [1/2]

typedef STRING FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::io_unit_y_type

protectedinherited

◆ io_unit_y_type [2/2]

typedef STRING FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::io_unit_y_type

protectedinherited

◆ 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

typedef FR_VECT_N_DATA_VALID_COMP_BYTES FrameCPP::Version_9::FrVectImpl::Data::n_data_valid_comp_bytes_type

inherited

◆ n_data_valid_type

typedef FR_VECT_N_DATA_VALID FrameCPP::Version_9::FrVectImpl::Data::n_data_valid_type

inherited

◆ name_type

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

inherited

◆ nBytes_type

typedef FR_VECT_NBYTES_TYPE FrameCPP::Version_9::FrVectImpl::Data::nBytes_type

inherited

◆ nBytes_v3_type

typedef INT_4U FrameCPP::Version_9::FrVectImpl::Data::nBytes_v3_type

inherited

◆ nData_type

typedef FR_VECT_NDATA_TYPE FrameCPP::Version_9::FrVectImpl::Data::nData_type

inherited

◆ nData_v3_type

typedef INT_4U FrameCPP::Version_9::FrVectImpl::Data::nData_v3_type

inherited

◆ nDim_type

typedef FR_VECT_NDIM_TYPE FrameCPP::Version_9::FrVectImpl::Data::nDim_type

inherited

◆ object_base_type [1/3]

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Version_9::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type

privateinherited

◆ object_base_type [2/3]

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Version_9::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type

privateinherited

◆ object_base_type [3/3]

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Version_9::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type

privateinherited

◆ object_type [1/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::object_type

privateinherited

Object with checksum data.

◆ object_type [2/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::object_type

privateinherited

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

template<typename Object_T>

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

inherited

◆ struct_id_type

template<typename Object_T>

typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type

inherited

◆ struct_name_type

template<typename Object_T>

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

inherited

◆ subfrvect_type [1/2]

typedef std::unique_ptr< FrVect > FrameCPP::Version_9::FrVect::subfrvect_type

◆ subfrvect_type [2/2]

typedef std::unique_ptr< FrVect > FrameCPP::Version_9::FrVect::subfrvect_type

◆ type_type

typedef FR_VECT_TYPE_TYPE FrameCPP::Version_9::FrVectImpl::Data::type_type

inherited

◆ unit_y_type

typedef std::string FrameCPP::Version_9::FrVectImpl::Data::unit_y_type

inherited

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

enum FrameCPP::Version_9::FrVectImpl::Data::compression_scheme_type

inherited

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

enum FrameCPP::Version_9::FrVectImpl::Data::data_types_type

inherited

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

◆ FrVect() [1/16]

FrVect::FrVect ( )

Default constructor.

Returns: A new instance of this object.

◆ FrVect() [2/16]

FrVect::FrVect ( const FrVect & vect )

Copy Constructor.

Parameters

[in] vect The object from which to copy the information.

Returns: A new instance of this object.

◆ FrVect() [3/16]

FrameCPP::Version_9::FrVect::FrVect	(	const std::string &	name,
		type_type	type,
		nDim_type	nDim,
		const Dimension *	dims,
		const byte_order_type	byte_order = BYTE_ORDER_HOST,
		const void *	data = 0,
		const std::string &	unitY = "" )

Constructor.

Parameters

[in]	name	The name of the data.
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	byte_order	Byte order of the data. Default is BYTE_ORDER_HOST
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""

Returns: A new instance of this object.

◆ FrVect() [4/16]

FrameCPP::Version_9::FrVect::FrVect	(	const std::string &	name,
		compress_type	Compress,
		type_type	type,
		nDim_type	nDim,
		const Dimension *	dims,
		nData_type	NData,
		nBytes_type	NBytes,
		data_type	Data,
		const std::string &	unitY = "" )

◆ FrVect() [5/16]

FrVect::FrVect	(	const std::string &	Name,
		type_type	Type,
		nDim_type	NDim,
		const Dimension *	Dims,
		const std::string &	UnitY )

Constructor.

Parameters

[in]	Name	The name of the data.
[in]	Type	The data type.
[in]	NDim	The number of dimensions.
[in]	Dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	UnitY	Units for the data.

Returns: A new instance of this object.

◆ FrVect() [6/16]

template<class T>

FrameCPP::Version_9::FrVect::FrVect	(	const std::string &	name,
		nDim_type	nDim = 1,
		const Dimension *	dims = 0,
		const T *	data = 0,
		const std::string &	unitY = "" )

◆ FrVect() [7/16]

template<class T>

FrameCPP::Version_9::FrVect::FrVect	(	const std::string &	name,
		nDim_type	nDim = 1,
		const Dimension *	dims = 0,
		T *	data = 0,
		const std::string &	unitY = "" )

◆ FrVect() [8/16]

FrVect::FrVect	(	const Previous::FrVect &	Source,
		stream_base_type *	Stream )

Promotion Constructor.

Parameters

[in]	Source	An FrAdcData structure from a previous frame specification.
[in]	Stream	The stream from which the earliest version of the FrAdcData structure was read.

Returns: A new instance of the object.

◆ ~FrVect() [1/2]

FrVect::~FrVect ( )

virtual

Destructor.

Reimplemented from FrameCPP::Common::FrVect.

◆ FrVect() [9/16]

FrameCPP::Version_9::FrVect::FrVect ( )

Default constructor.

Returns: A new instance of this object.

◆ FrVect() [10/16]

FrameCPP::Version_9::FrVect::FrVect ( const FrVect & vect )

Copy Constructor.

Parameters

[in] vect The object from which to copy the information.

Returns: A new instance of this object.

◆ FrVect() [11/16]

FrameCPP::Version_9::FrVect::FrVect	(	const std::string &	name,
		type_type	type,
		nDim_type	nDim,
		const Dimension *	dims,
		const byte_order_type	byte_order = BYTE_ORDER_HOST,
		const void *	data = 0,
		const std::string &	unitY = "" )

Constructor.

Parameters

[in]	name	The name of the data.
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	byte_order	Byte order of the data. Default is BYTE_ORDER_HOST
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""

Returns: A new instance of this object.

◆ FrVect() [12/16]

FrameCPP::Version_9::FrVect::FrVect	(	const std::string &	name,
		compress_type	Compress,
		type_type	type,
		nDim_type	nDim,
		const Dimension *	dims,
		nData_type	NData,
		nBytes_type	NBytes,
		data_type	Data,
		const std::string &	unitY = "" )

◆ FrVect() [13/16]

FrameCPP::Version_9::FrVect::FrVect	(	const std::string &	Name,
		type_type	Type,
		nDim_type	NDim,
		const Dimension *	Dims,
		const std::string &	UnitY )

Constructor.

Parameters

[in]	Name	The name of the data.
[in]	Type	The data type.
[in]	NDim	The number of dimensions.
[in]	Dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	UnitY	Units for the data.

Returns: A new instance of this object.

◆ FrVect() [14/16]

template<class T>

FrameCPP::Version_9::FrVect::FrVect	(	const std::string &	name,
		nDim_type	nDim = 1,
		const Dimension *	dims = 0,
		const T *	data = 0,
		const std::string &	unitY = "" )

◆ FrVect() [15/16]

template<class T>

FrameCPP::Version_9::FrVect::FrVect	(	const std::string &	name,
		nDim_type	nDim = 1,
		const Dimension *	dims = 0,
		T *	data = 0,
		const std::string &	unitY = "" )

◆ FrVect() [16/16]

FrameCPP::Version_9::FrVect::FrVect	(	const Previous::FrVect &	Source,
		stream_base_type *	Stream )

Promotion Constructor.

Parameters

[in]	Source	An FrAdcData structure from a previous frame specification.
[in]	Stream	The stream from which the earliest version of the FrAdcData structure was read.

Returns: A new instance of the object.

◆ ~FrVect() [2/2]

virtual FrameCPP::Version_9::FrVect::~FrVect ( )

virtual

Destructor.

Reimplemented from FrameCPP::Common::FrVect.

Member Function Documentation

◆ Bytes() [1/5]

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] Stream Stream 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/5]

static FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::Bytes	(	const OBJECT_TYPE &	Object,
		const Common::StreamBase &	Stream )

staticprivateinherited

◆ Bytes() [3/5]

static FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::Bytes	(	const OBJECT_TYPE &	Object,
		const Common::StreamBase &	Stream )

staticprivateinherited

◆ Bytes() [4/5]

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 )

privateinherited

◆ Bytes() [5/5]

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 )

privateinherited

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

static 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>

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

staticinherited

Comment to be used in comment field of FrSE.

◆ CloneCompressed() [1/2]

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

inlinevirtualinherited

Implements FrameCPP::Common::FrVect.

◆ CloneCompressed() [2/2]

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

inlinevirtualinherited

Implements FrameCPP::Common::FrVect.

◆ Compress()

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

inlineinherited

◆ compress_block()

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]	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

◆ compress_type_map()

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

inlinestaticprotectedinherited

◆ compress_type_reverse_map()

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

inlinestaticprotectedinherited

◆ CompressData()

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

inlinevirtualinherited

Implements FrameCPP::Common::FrVect.

◆ Compression()

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

inlinevirtualinherited

Implements FrameCPP::Common::FrVect.

◆ compressToBuffer()

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

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ Create() [2/6]

template<typename ObjectType, typename ChecksumType>

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

inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ 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] Stream The 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] Stream The 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()

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

inlineprotectedinherited

◆ data_copy()

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

inlineprotectedinherited

◆ data_type_map()

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

inlinestaticprotectedinherited

◆ DataAlloc() [1/2]

static 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]	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

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_9::FrVectImpl::Data::DataAlloc	(	type_type	Type,
		nData_type	NData )

inlinestaticinherited

Allocate a block of memory suitable for storing data.

Parameters

[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

Returns: Upon successful allocation, an appropriated sized buffer is returned. An expection is thrown for all error conditions.

◆ demote() [1/2]

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

inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of the previous generation.

◆ demote() [2/2]

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

inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of the previous generation.

◆ expandToBuffer() [1/2]

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/2]

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

inlineprotectedinherited

◆ FrameSpecDescription()

template<typename Object_T>

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

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId()

template<typename Object_T>

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

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName()

template<typename Object_T>

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

inlinestaticinherited

◆ GetCompress()

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

inlineinherited

Retrieve the compression algorithm number.

Returns: The compression algorithm number.

◆ GetData()

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/2]

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/2]

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()

template<class T>

static type_type FrameCPP::Version_9::FrVectImpl::Data::GetDataType ( )

staticinherited

◆ GetDataUncompressed() [1/2]

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/2]

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

inlineinherited

Retrieve the pointer to the uncompressed data.

Parameters

[in] Expanded Buffer into which the data is expanded.

Returns: The pointer to the uncompressed data.

◆ GetDataValid()

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()

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

inlineinherited

Retrieve the dataValid compression algorithm number.

Returns: The compression algorithm number.

◆ GetDataValidRaw()

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()

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]

virtual const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::GetDescription ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

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]

virtual const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::GetDescription ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

The data structure description.

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

◆ GetDim() [1/2]

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

inlineinherited

Retrieve the Nth dimension.

Parameters

[in] Offset Index for desired dimension

Returns: The Nth dimension

Todo: Throw exception if value out of range

◆ GetDim() [2/2]

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

inlineinherited

Retrieve the Nth dimension.

Parameters

[in] Offset Index for desired dimension

Returns: The Nth dimension

Todo: Throw exception if value out of range

◆ GetDims()

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 FrVect::name_type & FrVect::GetName ( ) const

Retrieve the name of message, error flag, or alarm state.

Returns: The name of message, error flag, or alarm state.

◆ GetName() [2/2]

const name_type & FrameCPP::Version_9::FrVect::GetName ( ) const

Retrieve the name of message, error flag, or alarm state.

Returns: The name of message, error flag, or alarm state.

◆ GetNBytes()

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()

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()

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()

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()

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

inlineinherited

Retrieve the number of dimensions.

Returns: The number of dimensions

◆ GetType()

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

inlineinherited

Retrieve the vector class.

Returns: The vector class.

◆ GetTypeSize() [1/2]

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

inlineinherited

◆ GetTypeSize() [2/2]

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

inlinestaticinherited

Get size of single data point of particular size.

Parameters

[in] Type Data type ID.

Returns: Data size.

◆ GetUnitY()

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

◆ load() [1/2]

void FrameCPP::Version_9::FrVectImpl::SerialIO< FrVect >::load	(	Archive &	ar,
		const unsigned int	version )

inlineprivateinherited

◆ load() [2/2]

void FrameCPP::Version_9::FrVectImpl::SerialIO< FrVect >::load	(	Archive &	ar,
		const unsigned int	version )

inlineprivateinherited

◆ Merge() [1/2]

FrVect & FrVect::Merge ( const FrVect & RHS )

Merge with another FrAdcData.

Parameters

[in] RHS The source of the information to append to this FrAdcData structure.

Returns: A reference to this object

Todo: Need to implement Merge routine

◆ Merge() [2/2]

FrVect & FrameCPP::Version_9::FrVect::Merge ( const FrVect & RHS )

Merge with another FrAdcData.

Parameters

[in] RHS The source of the information to append to this FrAdcData structure.

Returns: A reference to this object

◆ MimeData()

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]

virtual const char * FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::ObjectStructName ( ) const

inlineprotectedvirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::ObjectStructName ( ) const

inlineprotectedvirtualinherited

The name structure name of this object.

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

◆ operator!=() [1/2]

bool FrVect::operator!= ( const FrVect & RHS ) const

inequality operator

Parameters

[in] RHS The FrAdcData object to be compared.

Returns: The value true is returned if this object is not equivelent to the RHS instance; false otherwise.

◆ operator!=() [2/2]

bool FrameCPP::Version_9::FrVect::operator!= ( const FrVect & RHS ) const

inequality operator

Parameters

[in] RHS The FrAdcData object to be compared.

Returns: The value true is returned if this object is not equivelent to the RHS instance; false otherwise.

◆ operator+=() [1/2]

FrVect & FrVect::operator+= ( const FrVect & RHS )

Concatinate with another FrAdcData.

Parameters

[in] RHS The source of the information to append to this FrAdcData structure.

Returns: A reference to this object

Todo: Need to have a list of reasons

Todo: Need to have a list of reasons

◆ operator+=() [2/2]

FrVect & FrameCPP::Version_9::FrVect::operator+= ( const FrVect & RHS )

Concatinate with another FrAdcData.

Parameters

[in] RHS The source of the information to append to this FrAdcData structure.

Returns: A reference to this object

◆ operator==() [1/3]

bool FrVect::operator== ( const FrVect & RHS ) const

equality operator

Parameters

[in] RHS The FrAdcData object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/3]

bool FrameCPP::Version_9::FrVect::operator== ( const FrVect & RHS ) const

equality operator

Parameters

[in] RHS The FrAdcData object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/3]

bool FrameCPP::Version_9::FrVectImpl::ClassicIO< FrameCPP::Version_9::FrVect >::operator== ( const Common::FrameSpec::Object & Obj ) const

inherited

◆ pBytes() [1/2]

virtual FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters

[in] Stream The 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]

virtual FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters

[in] Stream The 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]

virtual self_type * FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtualinherited

Stream constructor.

Parameters

[in] Stream The input stream from where the object is being read.

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

◆ pCreate() [2/2]

virtual self_type * FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtualinherited

Stream constructor.

Parameters

[in] Stream The input stream from where the object is being read.

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

◆ Promote() [1/2]

static promote_ret_type FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		promote_stream_type *	Stream )

inlinestaticinherited

Promote previous version of object to this version.

Parameters

[in]	Source	The frame specification version of the object.
[in]	Obj	The previous version of the object.
[in]	Stream	Stream from which the origional object was created.

Returns: A new instance of FrameH based on Obj

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		promote_stream_type *	Stream )

inlinestaticinherited

Promote previous version of object to this version.

Parameters

[in]	Source	The frame specification version of the object.
[in]	Obj	The previous version of the object.
[in]	Stream	Stream from which the origional object was created.

Returns: A new instance of FrameH based on Obj

◆ promote() [1/2]

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

inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters

[in]	Target	The version of the promoted frame specification.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object promoted to the next generation.

◆ promote() [2/2]

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

inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters

[in]	Target	The version of the promoted frame specification.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object promoted to the next generation.

◆ pWrite() [1/2]

virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

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

◆ pWrite() [2/2]

virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

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

◆ save() [1/2]

void FrameCPP::Version_9::FrVectImpl::SerialIO< FrVect >::save	(	Archive &	ar,
		const unsigned int	version ) const

inlineprivateinherited

◆ save() [2/2]

void FrameCPP::Version_9::FrVectImpl::SerialIO< FrVect >::save	(	Archive &	ar,
		const unsigned int	version ) const

inlineprivateinherited

◆ SetDataValid()

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()

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] Name The channel name

◆ SetNData()

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

inlineinherited

◆ SetUnitY()

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] UnitY New description

Returns: The description of how to interpret each element

◆ StructDescription() [1/2]

static const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::StructDescription ( )

inlinestaticinherited

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >::StructDescription ( )

inlinestaticinherited

◆ StructName()

template<typename Object_T>

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

inlinestaticinherited

◆ SubFrVect() [1/2]

FrVect::subfrvect_type FrVect::SubFrVect	(	INT_4U	Start,
		INT_4U	Stop ) const

Request a subset of the data.

Parameters

[in]	Start	The offset in the data set where to start.
[in]	Stop	The offset in the data set where to stop.

Returns: The subset of data bounded by data[Start, Stop).

◆ SubFrVect() [2/2]

subfrvect_type FrameCPP::Version_9::FrVect::SubFrVect	(	INT_4U	Start,
		INT_4U	Stop ) const

Request a subset of the data.

Parameters

[in]	Start	The offset in the data set where to start.
[in]	Stop	The offset in the data set where to stop.

Returns: The subset of data bounded by data[Start, Stop).

◆ Uncompress()

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()

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]

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

inlineprotectedvirtualinherited

Verify the integrity of the object.

Parameters

Verifier	The handle to the Verify object used to store data that needs to be accumulated before being processed.
Stream	The input stream from which the object was created.

Remarks: Upon failure, this method thows an exception.

◆ VerifyObject() [2/2]

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

inlineprotectedvirtualinherited

Verify the integrity of the object.

Parameters

Verifier	The handle to the Verify object used to store data that needs to be accumulated before being processed.
Stream	The 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

static 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

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/FrVect.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/FrVect.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/FrVect.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ cmn_compression_level_type

◆ cmn_compression_scheme_type

◆ compress_type

◆ compression_level_type

◆ data_const_pointer_type

◆ data_element_type

◆ data_pointer_type

◆ data_type

◆ data_valid_comp_scheme_type

◆ data_valid_type

◆ dimension_container_type

◆ io_name_type [1/2]

◆ io_name_type [2/2]

◆ io_unit_y_type [1/2]

◆ io_unit_y_type [2/2]

◆ istream_type [1/2]

◆ istream_type [2/2]

◆ n_data_valid_comp_bytes_type

◆ n_data_valid_type

◆ name_type

◆ nBytes_type

◆ nBytes_v3_type

◆ nData_type

◆ nData_v3_type

◆ nDim_type

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ object_type [1/2]

◆ object_type [2/2]

◆ ostream_type [1/2]

◆ ostream_type [2/2]

◆ self_type [1/2]

◆ self_type [2/2]

◆ struct_desc_type

◆ struct_id_type

◆ struct_name_type

◆ subfrvect_type [1/2]

◆ subfrvect_type [2/2]

◆ type_type

◆ unit_y_type

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ compression_scheme_type

◆ data_types_type

Constructor & Destructor Documentation

◆ FrVect() [1/16]

◆ FrVect() [2/16]

◆ FrVect() [3/16]

◆ FrVect() [4/16]

◆ FrVect() [5/16]

◆ FrVect() [6/16]

◆ FrVect() [7/16]

◆ FrVect() [8/16]

◆ ~FrVect() [1/2]

◆ FrVect() [9/16]

◆ FrVect() [10/16]

◆ FrVect() [11/16]

◆ FrVect() [12/16]

◆ FrVect() [13/16]

◆ FrVect() [14/16]

◆ FrVect() [15/16]

◆ FrVect() [16/16]