ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrVect Class Reference

Vector Data Structure Definition. More...

#include <FrVect.hh>

Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::FrVect, FrVectDataTypes, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::FrVect, and FrVectDataTypes.

Public Member Functions

 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, Common::IStream *Stream)
 Promotion Constructor.
 
virtual ~FrVect ()
 Destructor.
 
void MimeData (const std::string &MimeType, void *Data, nBytes_type DataSize)
 Set the current FrVect with the MIME data.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
bool operator== (const FrVect &RHS) const
 equality operator
 
bool operator!= (const FrVect &RHS) const
 inequality operator
 
FrVectoperator+= (const FrVect &RHS)
 Concatinate with another FrAdcData.
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator
 
const std::string & GetName () const
 Retrieve the channel name.
 
compress_type GetCompress () const
 Retrieve the compression algorithm number.
 
type_type GetType () const
 Retrieve the vector class.
 
nData_type GetNData () const
 Retrieve the number of sample elements in data series.
 
nBytes_type GetNBytes () const
 Retrieve the number of bytes in the compressed vector.
 
data_type GetData () const
 Retrieve the pointer to the data.
 
data_type GetDataRaw () const
 Retrieve the pointer to the compressed data.
 
data_type GetDataRaw ()
 Retrieve the pointer to the compressed data.
 
data_type 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 DimensionGetDim (nDim_type Offset) const
 Retrieve the Nth dimension.
 
DimensionGetDim (nDim_type Offset)
 Retrieve the Nth dimension.
 
dimension_container_type & GetDims ()
 Retrieve all the dimension information.
 
const std::string & GetUnitY () const
 Retrieve the description of how to interpret each element.
 
void Uncompress ()
 Expand compressed data.
 
void SetName (const std::string &Name)
 Establish the channel name.
 
void SetUnitY (const std::string &UnitY)
 Set the description of how to interpret each element.
 
FrVectMerge (const FrVect &RHS)
 Merge with another FrAdcData.
 
subfrvect_type SubFrVect (INT_4U Start, INT_4U Stop) const
 Request a subset of the data.
 
 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, Common::IStream *Stream)
 Promotion Constructor.
 
virtual ~FrVect ()
 Destructor.
 
void MimeData (const std::string &MimeType, void *Data, nBytes_type DataSize)
 Set the current FrVect with the MIME data.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
bool operator== (const FrVect &RHS) const
 equality operator
 
bool operator!= (const FrVect &RHS) const
 inequality operator
 
FrVectoperator+= (const FrVect &RHS)
 Concatinate with another FrAdcData.
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator
 
const std::string & GetName () const
 Retrieve the channel name.
 
compress_type GetCompress () const
 Retrieve the compression algorithm number.
 
type_type GetType () const
 Retrieve the vector class.
 
nData_type GetNData () const
 Retrieve the number of sample elements in data series.
 
nBytes_type GetNBytes () const
 Retrieve the number of bytes in the compressed vector.
 
data_type GetData () const
 Retrieve the pointer to the data.
 
data_type GetDataRaw () const
 Retrieve the pointer to the compressed data.
 
data_type GetDataRaw ()
 Retrieve the pointer to the compressed data.
 
data_type 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 DimensionGetDim (nDim_type Offset) const
 Retrieve the Nth dimension.
 
DimensionGetDim (nDim_type Offset)
 Retrieve the Nth dimension.
 
dimension_container_type & GetDims ()
 Retrieve all the dimension information.
 
const std::string & GetUnitY () const
 Retrieve the description of how to interpret each element.
 
void SetName (const std::string &Name)
 Establish the channel name.
 
void SetUnitY (const std::string &UnitY)
 Set the description of how to interpret each element.
 
FrVectMerge (const FrVect &RHS)
 Merge with another FrAdcData.
 
subfrvect_type SubFrVect (INT_4U Start, INT_4U Stop) const
 Request a subset of the data.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (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.
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static data_type DataAlloc (type_type Type, const Dimension *Dims, const nDim_type NDim=1)
 Allocate a block of memory suitable for storing data.
 
static size_t GetTypeSize (type_type Type)
 Get size of single data point of particular size.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static data_type DataAlloc (type_type Type, const Dimension *Dims, const nDim_type NDim=1)
 Allocate a block of memory suitable for storing data.
 
static size_t GetTypeSize (type_type Type)
 Get size of single data point of particular size.
 
static 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.
 

Protected Member Functions

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, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *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 FrVectpCreate (Common::IStream &Stream) const
 Stream constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
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, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *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 FrVectpCreate (Common::IStream &Stream) const
 Stream constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 

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]vectThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrVect() [3/10]

FrameCPP::Version_8::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]nameThe name of the data.
[in]typeThe data type.
[in]nDimThe number of dimensions.
[in]dimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]byte_orderByte order of the data. Default is BYTE_ORDER_HOST
[in]dataA pointer to the data. Default: 0
[in]unitYUnits 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]NameThe name of the data.
[in]TypeThe data type.
[in]NDimThe number of dimensions.
[in]DimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]UnitYUnits for the data.
Returns
A new instance of this object.

◆ FrVect() [5/10]

FrVect::FrVect ( const Previous::FrVect & Source,
Common::IStream * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrAdcData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrAdcData structure was read.
Returns
A new instance of the object.

◆ FrVect() [6/10]

FrameCPP::Version_8::FrVect::FrVect ( )

Default constructor.

Returns
A new instance of this object.

◆ FrVect() [7/10]

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

Copy Constructor.

Parameters
[in]vectThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrVect() [8/10]

FrameCPP::Version_8::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]nameThe name of the data.
[in]typeThe data type.
[in]nDimThe number of dimensions.
[in]dimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]byte_orderByte order of the data. Default is BYTE_ORDER_HOST
[in]dataA pointer to the data. Default: 0
[in]unitYUnits for the data. Default: ""
Returns
A new instance of this object.

◆ FrVect() [9/10]

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

Constructor.

Parameters
[in]NameThe name of the data.
[in]TypeThe data type.
[in]NDimThe number of dimensions.
[in]DimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]UnitYUnits for the data.
Returns
A new instance of this object.

◆ FrVect() [10/10]

FrameCPP::Version_8::FrVect::FrVect ( const Previous::FrVect & Source,
Common::IStream * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrAdcData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrAdcData structure was read.
Returns
A new instance of the object.

Member Function Documentation

◆ Bytes() [1/2]

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

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]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Create() [1/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [2/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ DataAlloc() [1/2]

FrVect::data_type FrVect::DataAlloc ( type_type Type,
const Dimension * Dims,
const nDim_type NDim = 1 )
static

Allocate a block of memory suitable for storing data.

Parameters
[in]TypeThe type of data that is to be stored in the buffer.
[in]DimsInformation concearning each dimension of the array of data to be stored in the buffer.
[in]NDimThe number of dimensions of data to be stored in the buffer
Returns
Upon successful allocation, an appropriated sized buffer is returned. An expection is thrown for all error conditions.

◆ DataAlloc() [2/2]

static data_type FrameCPP::Version_8::FrVect::DataAlloc ( type_type Type,
const Dimension * Dims,
const nDim_type NDim = 1 )
static

Allocate a block of memory suitable for storing data.

Parameters
[in]TypeThe type of data that is to be stored in the buffer.
[in]DimsInformation concearning each dimension of the array of data to be stored in the buffer.
[in]NDimThe number of dimensions of data to be stored in the buffer
Returns
Upon successful allocation, an appropriated sized buffer is returned. An expection is thrown for all error conditions.

◆ demote() [1/2]

FrVect::demote_ret_type FrVect::demote ( INT_2U Target,
demote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe 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_8::FrVect::demote ( INT_2U Target,
demote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ GetCompress() [1/2]

FrVect::compress_type FrameCPP::Version_8::FrVect::GetCompress ( ) const
inline

Retrieve the compression algorithm number.

Returns
The compression algorithm number.

◆ GetCompress() [2/2]

compress_type FrameCPP::Version_8::FrVect::GetCompress ( ) const

Retrieve the compression algorithm number.

Returns
The compression algorithm number.

◆ GetData() [1/2]

FrVect::data_type FrameCPP::Version_8::FrVect::GetData ( ) const
inline

Retrieve the pointer to the data.

Returns
The pointer to the data.
Note
This will expand the data if it is currently compressed.

Return a pointer to the data being managed by the FrVect structure.

See also
GetDataRaw, GetDataUncompressed

◆ GetData() [2/2]

data_type FrameCPP::Version_8::FrVect::GetData ( ) const

Retrieve the pointer to the data.

Returns
The pointer to the data.
Note
This will expand the data if it is currently compressed.

◆ GetDataRaw() [1/4]

FrVect::data_type FrVect::GetDataRaw ( )

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataRaw() [2/4]

data_type FrameCPP::Version_8::FrVect::GetDataRaw ( )

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataRaw() [3/4]

FrVect::data_type FrVect::GetDataRaw ( ) const

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataRaw() [4/4]

data_type FrameCPP::Version_8::FrVect::GetDataRaw ( ) const

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataUncompressed() [1/4]

FrVect::data_type FrVect::GetDataUncompressed ( )

Retrieve the pointer to the uncompressed data.

Returns
The pointer to the uncompressed data.

◆ GetDataUncompressed() [2/4]

data_type FrameCPP::Version_8::FrVect::GetDataUncompressed ( )

Retrieve the pointer to the uncompressed data.

Returns
The pointer to the uncompressed data.

◆ GetDataUncompressed() [3/4]

FrVect::data_const_pointer_type FrVect::GetDataUncompressed ( data_type & Expanded) const

Retrieve the pointer to the uncompressed data.

Parameters
[in]ExpandedBuffer into which the data is expanded.
Returns
The pointer to the uncompressed data.

◆ GetDataUncompressed() [4/4]

const CHAR_U * FrameCPP::Version_8::FrVect::GetDataUncompressed ( data_type & Expanded) const

Retrieve the pointer to the uncompressed data.

Parameters
[in]ExpandedBuffer into which the data is expanded.
Returns
The pointer to the uncompressed data.

◆ GetDim() [1/4]

Dimension & FrameCPP::Version_8::FrVect::GetDim ( nDim_type Offset)
inline

Retrieve the Nth dimension.

Parameters
[in]OffsetIndex for desired dimension
Returns
The Nth dimension
Todo
Throw exception if value out of range
Todo
Throw exception if value out of range

◆ GetDim() [2/4]

Dimension & FrameCPP::Version_8::FrVect::GetDim ( nDim_type Offset)

Retrieve the Nth dimension.

Parameters
[in]OffsetIndex for desired dimension
Returns
The Nth dimension

◆ GetDim() [3/4]

const Dimension & FrameCPP::Version_8::FrVect::GetDim ( nDim_type Offset) const
inline

Retrieve the Nth dimension.

Parameters
[in]OffsetIndex for desired dimension
Returns
The Nth dimension
Todo
Throw exception if value out of range
Todo
Throw exception if value out of range

◆ GetDim() [4/4]

const Dimension & FrameCPP::Version_8::FrVect::GetDim ( nDim_type Offset) const

Retrieve the Nth dimension.

Parameters
[in]OffsetIndex for desired dimension
Returns
The Nth dimension

◆ GetDims() [1/2]

FrVect::dimension_container_type & FrameCPP::Version_8::FrVect::GetDims ( )
inline

Retrieve all the dimension information.

Returns
The colletion of dimension data

◆ GetDims() [2/2]

dimension_container_type & FrameCPP::Version_8::FrVect::GetDims ( )

Retrieve all the dimension information.

Returns
The colletion of dimension data

◆ GetName() [1/2]

const std::string & FrVect::GetName ( ) const

Retrieve the channel name.

Returns
The channel name

◆ GetName() [2/2]

const std::string & FrameCPP::Version_8::FrVect::GetName ( ) const

Retrieve the channel name.

Returns
The channel name

◆ GetNBytes() [1/2]

FrVect::nBytes_type FrameCPP::Version_8::FrVect::GetNBytes ( ) const
inline

Retrieve the number of bytes in the compressed vector.

Returns
The number of bytes in the compressed vector.

◆ GetNBytes() [2/2]

nBytes_type FrameCPP::Version_8::FrVect::GetNBytes ( ) const

Retrieve the number of bytes in the compressed vector.

Returns
The number of bytes in the compressed vector.

◆ GetNData() [1/2]

FrVect::nData_type FrameCPP::Version_8::FrVect::GetNData ( ) const
inline

Retrieve the number of sample elements in data series.

Returns
The number of sample elements in data series.

◆ GetNData() [2/2]

nData_type FrameCPP::Version_8::FrVect::GetNData ( ) const

Retrieve the number of sample elements in data series.

Returns
The number of sample elements in data series.

◆ GetNDim() [1/2]

FrVect::nDim_type FrameCPP::Version_8::FrVect::GetNDim ( ) const
inline

Retrieve the number of dimensions.

Returns
The number of dimensions

◆ GetNDim() [2/2]

nDim_type FrameCPP::Version_8::FrVect::GetNDim ( ) const

Retrieve the number of dimensions.

Returns
The number of dimensions

◆ GetType() [1/2]

FrVect::type_type FrameCPP::Version_8::FrVect::GetType ( ) const
inline

Retrieve the vector class.

Returns
The vector class.

◆ GetType() [2/2]

type_type FrameCPP::Version_8::FrVect::GetType ( ) const

Retrieve the vector class.

Returns
The vector class.

◆ GetTypeSize() [1/2]

size_t FrVect::GetTypeSize ( type_type Type)
static

Get size of single data point of particular size.

Parameters
[in]TypeData type ID.
Returns
Data size.

◆ GetTypeSize() [2/2]

static size_t FrameCPP::Version_8::FrVect::GetTypeSize ( type_type Type)
static

Get size of single data point of particular size.

Parameters
[in]TypeData type ID.
Returns
Data size.

◆ GetUnitY() [1/2]

const std::string & FrameCPP::Version_8::FrVect::GetUnitY ( ) const
inline

Retrieve the description of how to interpret each element.

Returns
The description of how to interpret each element

◆ GetUnitY() [2/2]

const std::string & FrameCPP::Version_8::FrVect::GetUnitY ( ) const

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]RHSThe 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_8::FrVect::Merge ( const FrVect & RHS)

Merge with another FrAdcData.

Parameters
[in]RHSThe source of the information to append to this FrAdcData structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

const char * FrVect::ObjectStructName ( ) const
virtual

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_8::FrVect::ObjectStructName ( ) const
virtual

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]RHSThe 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_8::FrVect::operator!= ( const FrVect & RHS) const

inequality operator

Parameters
[in]RHSThe 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]RHSThe 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_8::FrVect::operator+= ( const FrVect & RHS)

Concatinate with another FrAdcData.

Parameters
[in]RHSThe source of the information to append to this FrAdcData structure.
Returns
A reference to this object

◆ operator==() [1/4]

bool FrVect::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator

Parameters
[in]RHSThe FrVect object to be compared.
Returns
The value true is returned if the object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/4]

virtual bool FrameCPP::Version_8::FrVect::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator

Parameters
[in]RHSThe FrVect object to be compared.
Returns
The value true is returned if the object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/4]

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

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/4]

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

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

FrameCPP::cmn_streamsize_type FrVect::pBytes ( const Common::StreamBase & Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe 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, checksum_type >.

◆ pBytes() [2/2]

virtual FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrVect::pBytes ( const Common::StreamBase & Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe 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, checksum_type >.

◆ pCreate() [1/2]

FrVect * FrVect::pCreate ( Common::IStream & Stream) const
protectedvirtual

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

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

◆ pCreate() [2/2]

virtual FrVect * FrameCPP::Version_8::FrVect::pCreate ( Common::IStream & Stream) const
protectedvirtual

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

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

◆ Promote() [1/2]

FrVect::promote_ret_type FrameCPP::Version_8::FrVect::Promote ( INT_2U Source,
promote_arg_type Obj,
Common::IStream * Stream )
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream 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_8::FrVect::Promote ( INT_2U Source,
promote_arg_type Obj,
Common::IStream * Stream )
static

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

FrVect::promote_ret_type FrVect::promote ( INT_2U Target,
promote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe 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_8::FrVect::promote ( INT_2U Target,
promote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ pWrite() [1/2]

void FrVect::pWrite ( Common::OStream & Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

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

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrVect::pWrite ( Common::OStream & Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

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

◆ SetName() [1/2]

void FrameCPP::Version_8::FrVect::SetName ( const std::string & Name)
inline

Establish the channel name.

Assign a new value for the channel name.

Parameters
[in]NameThe channel name

◆ SetName() [2/2]

void FrameCPP::Version_8::FrVect::SetName ( const std::string & Name)

Establish the channel name.

Parameters
[in]NameThe channel name

◆ SetUnitY() [1/2]

void FrameCPP::Version_8::FrVect::SetUnitY ( const std::string & UnitY)
inline

Set the description of how to interpret each element.

Assign a new value for the channel name.

Parameters
[in]UnitYNew description
Returns
The description of how to interpret each element

◆ SetUnitY() [2/2]

void FrameCPP::Version_8::FrVect::SetUnitY ( const std::string & UnitY)

Set the description of how to interpret each element.

Parameters
[in]UnitYNew description
Returns
The description of how to interpret each element

◆ StructDescription() [1/2]

const Description * FrVect::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_8::FrVect::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/2]

const char * FrameCPP::Version_8::FrVect::StructName ( )
inlinestatic

The name structure name of this object.

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

◆ StructName() [2/2]

static const char * FrameCPP::Version_8::FrVect::StructName ( )
static

The name structure name of this object.

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

◆ SubFrVect() [1/2]

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

Request a subset of the data.

Parameters
[in]StartThe offset in the data set where to start.
[in]StopThe 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_8::FrVect::SubFrVect ( INT_4U Start,
INT_4U Stop ) const

Request a subset of the data.

Parameters
[in]StartThe offset in the data set where to start.
[in]StopThe offset in the data set where to stop.
Returns
The subset of data bounded by data[Start, Stop).

◆ Uncompress()

void FrVect::Uncompress ( )

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]

void FrVect::VerifyObject ( Common::Verify & Verifier,
Common::IFrameStream & Stream ) const
protectedvirtual

Verify the integrity of the object.

Parameters
VerifierThe handle to the Verify object used to store data that needs to be accumulated before being processed.
StreamThe input stream from which the object was created.
Remarks
Upon failure, this method thows an exception.

This routine is called to verify the integrety of this FrVect object.

◆ VerifyObject() [2/2]

virtual void FrameCPP::Version_8::FrVect::VerifyObject ( Common::Verify & Verifier,
Common::IFrameStream & Stream ) const
protectedvirtual

Verify the integrity of the object.

Parameters
VerifierThe handle to the Verify object used to store data that needs to be accumulated before being processed.
StreamThe 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: