Vector Data Structure Definition. More...

#include <FrVect.hh>

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, type_type Type, nDim_type NDim, const Dimension *Dims, const std::string &UnitY)
	Constructor.
	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, type_type Type, nDim_type NDim, const Dimension *Dims, const std::string &UnitY)
	Constructor.
	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.
virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
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 void	Write (ostream_type &Stream) const
	Write object to the stream.
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 void	Write (ostream_type &Stream) const
	Write object to the stream.
compress_type	GetCompress () const
	Retrieve the compression algorithm number.
type_type	GetType () const
	Retrieve the vector class.
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	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	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 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 *	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 *	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 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 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.
static struct_desc_type	FrameSpecDescription ()
	Return the dictionary name of the structure.
static struct_id_type	FrameSpecId ()
	Return the dictionary name of the structure.

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.

Detailed Description

Vector Data Structure Definition.

Constructor & Destructor Documentation

◆ FrVect() [1/10]

FrVect::FrVect ( )

Default constructor.

Returns: A new instance of this object.

◆ FrVect() [2/10]

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

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

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() [5/10]

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() [6/10]

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

Default constructor.

Returns: A new instance of this object.

◆ FrVect() [7/10]

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() [8/10]

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() [9/10]

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() [10/10]

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.

Member Function Documentation

◆ Bytes()

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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

◆ 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

◆ Create() [1/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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() [2/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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() [3/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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() [6/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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.

◆ DataAlloc() [1/2]

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]

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]

template<typename T>

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

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]

template<typename T>

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

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.

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

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

template<typename T>

virtual const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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]

template<typename T>

virtual const Common::Description * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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()

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

◆ 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

◆ ObjectStructName() [1/2]

template<typename T>

virtual const char * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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]

template<typename T>

virtual const char * FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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]

template<typename T>

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

virtualinherited

equality operator for abstract data type

Parameters

[in] RHS The object to be compared.

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

◆ pBytes() [1/2]

template<typename T>

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

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.

◆ pBytes() [2/2]

template<typename T>

virtual FrameCPP::cmn_streamsize_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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.

◆ pCreate() [1/2]

template<typename T>

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

inlineprotectedvirtualinherited

Stream constructor.

Parameters

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

◆ pCreate() [2/2]

template<typename T>

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

inlineprotectedvirtualinherited

Stream constructor.

Parameters

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

◆ Promote() [1/2]

template<typename T>

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

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]

template<typename T>

promote_ret_type FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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]

template<typename T>

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

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]

template<typename T>

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

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]

template<typename T>

virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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.

◆ pWrite() [2/2]

template<typename T>

virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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.

◆ 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

◆ 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

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

◆ VerifyObject() [1/2]

template<typename T>

virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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]

template<typename T>

virtual void FrameCPP::Version_9::FrVectImpl::ClassicIO< T >::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.

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

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FrVect() [1/10]

◆ FrVect() [2/10]

◆ FrVect() [3/10]

◆ FrVect() [4/10]

◆ FrVect() [5/10]

◆ FrVect() [6/10]

◆ FrVect() [7/10]

◆ FrVect() [8/10]

◆ FrVect() [9/10]

◆ FrVect() [10/10]

Member Function Documentation

◆ Bytes()

◆ compress_block()

◆ Create() [1/6]

◆ Create() [2/6]

◆ Create() [3/6]

◆ Create() [4/6]

◆ Create() [5/6]

◆ Create() [6/6]

◆ DataAlloc() [1/2]

◆ DataAlloc() [2/2]

◆ demote() [1/2]

◆ demote() [2/2]

◆ GetCompress()

◆ GetData()

◆ GetDataRaw() [1/2]

◆ GetDataRaw() [2/2]

◆ GetDataUncompressed() [1/2]

◆ GetDataUncompressed() [2/2]

◆ GetDataValid()

◆ GetDataValidCompress()

◆ GetDataValidRaw()

◆ GetDataValidUncompressed()

◆ GetDescription() [1/2]

◆ GetDescription() [2/2]

◆ GetDim() [1/2]

◆ GetDim() [2/2]

◆ GetDims()

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ GetNBytes()

◆ GetNData()

◆ GetNDataValid()

◆ GetNDataValidBytes()

◆ GetNDim()

◆ GetType()

◆ GetTypeSize()

◆ GetUnitY()

◆ Merge() [1/2]

◆ Merge() [2/2]

◆ ObjectStructName() [1/2]

◆ ObjectStructName() [2/2]

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ pBytes() [1/2]

◆ pBytes() [2/2]

◆ pCreate() [1/2]

◆ pCreate() [2/2]

◆ Promote() [1/2]

◆ Promote() [2/2]

◆ promote() [1/2]

◆ promote() [2/2]

◆ pWrite() [1/2]

◆ pWrite() [2/2]

◆ SetDataValid()

◆ SetName()

◆ SetUnitY()

◆ SubFrVect() [1/2]

◆ SubFrVect() [2/2]

◆ Uncompress()