ldas-tools-framecpp  2.6.5
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
FrameCPP::Version_8::FrVect Class Reference

Vector Data Structure Definition. More...

#include <FrVect.hh>

Inheritance diagram for FrameCPP::Version_8::FrVect:
FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Common::FrVect FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

enum  compression_scheme_type {
  CST_DECL =( RAW, 0 ), CST_DECL =( RAW, 0 ), CST_DECL =( RAW, 0 ), CST_DECL =( RAW, 0 ),
  CST_DECL =( RAW, 0 ), CST_DECL =( RAW, 0 ), CST_DECL =( RAW, 0 ), ZERO_SUPPRESS_OTHERWISE_GZIP = 6,
  BEST_COMPRESSION = 9, ZERO_SUPPRESS_SHORT = ZERO_SUPPRESS_WORD_2, ZERO_SUPPRESS_INT_FLOAT = ZERO_SUPPRESS_WORD_4, 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
}
 
typedef FR_VECT_COMPRESSION_LEVEL_TYPE compression_level_type
 
typedef FR_VECT_COMPRESS_TYPE compress_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_typedata_pointer_type
 
typedef const data_element_typedata_const_pointer_type
 
typedef std::vector< Dimensiondimension_container_type
 
typedef std::unique_ptr< FrVectsubfrvect_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeself_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef INT_4U cmn_compression_scheme_type
 
typedef INT_2U cmn_compression_level_type
 

Public Member Functions

 FrVect ()
 Default constructor. More...
 
 FrVect (const FrVect &vect)
 Copy Constructor. More...
 
 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. More...
 
 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. More...
 
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, Common::IStream *Stream)
 Promotion Constructor. More...
 
virtual ~FrVect ()
 Destructor. More...
 
void MimeData (const std::string &MimeType, void *Data, nBytes_type DataSize)
 Set the current FrVect with the MIME data. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
bool operator== (const FrVect &RHS) const
 equality operator More...
 
bool operator!= (const FrVect &RHS) const
 inequality operator More...
 
FrVectoperator+= (const FrVect &RHS)
 Concatinate with another FrAdcData. More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator More...
 
const std::string & GetName () const
 Retrieve the channel name. More...
 
compress_type GetCompress () const
 Retrieve the compression algorithm number. More...
 
type_type GetType () const
 Retrieve the vector class. More...
 
nData_type GetNData () const
 Retrieve the number of sample elements in data series. More...
 
nBytes_type GetNBytes () const
 Retrieve the number of bytes in the compressed vector. More...
 
data_type GetData () const
 Retrieve the pointer to the data. More...
 
data_type GetDataRaw () const
 Retrieve the pointer to the compressed data. More...
 
data_type GetDataRaw ()
 Retrieve the pointer to the compressed data. More...
 
data_type GetDataUncompressed ()
 Retrieve the pointer to the uncompressed data. More...
 
const CHAR_U * GetDataUncompressed (data_type &Expanded) const
 Retrieve the pointer to the uncompressed data. More...
 
nDim_type GetNDim () const
 Retrieve the number of dimensions. More...
 
const DimensionGetDim (nDim_type Offset) const
 Retrieve the Nth dimension. More...
 
DimensionGetDim (nDim_type Offset)
 Retrieve the Nth dimension. More...
 
dimension_container_typeGetDims ()
 Retrieve all the dimension information. More...
 
const std::string & GetUnitY () const
 Retrieve the description of how to interpret each element. More...
 
void Compress (compression_scheme_type Scheme, int GZipLevel)
 
void Uncompress ()
 
virtual void CompressData (INT_4U Scheme, INT_2U GZipLevel)
 
virtual Compression::compression_base_type Compression () const
 
virtual Common::FrameSpec::ObjectCloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const
 
void SetName (const std::string &Name)
 Establish the channel name. More...
 
void SetUnitY (const std::string &UnitY)
 Set the description of how to interpret each element. More...
 
void SetNData (nData_type NData)
 
size_t GetTypeSize () const
 
FrVectMerge (const FrVect &RHS)
 Merge with another FrAdcData. More...
 
subfrvect_type SubFrVect (INT_4U Start, INT_4U Stop) const
 Request a subset of the data. More...
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
template<>
FrVect::type_type GetDataType ()
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *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. More...
 
static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static data_type DataAlloc (type_type Type, const Dimension *Dims, const nDim_type NDim=1)
 Allocate a block of memory suitable for storing data. More...
 
template<class T >
static type_type GetDataType ()
 
static size_t GetTypeSize (type_type Type)
 Get size of single data point of particular size. More...
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE. More...
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 

Static Public Attributes

static const int DEFAULT_GZIP_LEVEL
 

Protected Member Functions

virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the integrity of the object. More...
 
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. More...
 
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. More...
 
virtual FrameCPP::cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrVectpCreate (Common::IStream &Stream) const
 Stream constructor. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
void expandToBuffer (data_type &Dest, nBytes_type &DestNBytes) const
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
void compressToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::compress_type_reverse_mapping &CompressionReverseMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, Compression::output_type &Dest, INT_8U &DestNBytes, INT_4U &DestCompressionMode, const INT_4U Level) const
 
void 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
 

Detailed Description

Vector Data Structure Definition.

Member Typedef Documentation

◆ cmn_compression_level_type

◆ cmn_compression_scheme_type

◆ compress_type

◆ compression_level_type

◆ data_const_pointer_type

◆ data_element_type

typedef data_type::element_type FrameCPP::Version_8::FrVect::data_element_type

◆ data_pointer_type

◆ data_type

typedef boost::shared_array< CHAR_U > FrameCPP::Version_8::FrVect::data_type

◆ demote_arg_type

◆ demote_ret_type

◆ dimension_container_type

◆ frame_spec_version_type

◆ istream_type

◆ nBytes_type

◆ nData_type

◆ nDim_type

◆ ostream_type

◆ promote_arg_type

◆ promote_ret_type

◆ self_type

◆ subfrvect_type

◆ type_type

◆ unique_object_type

Member Enumeration Documentation

◆ compression_scheme_type

Enumerator
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_OTHERWISE_GZIP 
BEST_COMPRESSION 
ZERO_SUPPRESS_SHORT 
ZERO_SUPPRESS_INT_FLOAT 
NONE 

◆ data_types_type

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 

Constructor & Destructor Documentation

◆ FrVect() [1/8]

FrVect::FrVect ( )

Default constructor.

Returns
A new instance of this object.

◆ FrVect() [2/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() [3/8]

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

FrameCPP::Version_8::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/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() [6/8]

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

◆ FrVect() [7/8]

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

◆ FrVect() [8/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.

◆ ~FrVect()

FrVect::~FrVect ( )
virtual

Destructor.

Reimplemented from FrameCPP::Common::FrVect.

Member Function Documentation

◆ Bytes()

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ CheckSumDataClass()

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment()

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Clone()

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

◆ CloneCompressed()

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

◆ Compress()

void FrVect::Compress ( compression_scheme_type  Scheme,
int  GZipLevel 
)

◆ CompressData()

void FrVect::CompressData ( INT_4U  Scheme,
INT_2U  GZipLevel 
)
virtual

◆ Compression()

Compression::compression_base_type FrameCPP::Version_8::FrVect::Compression ( ) const
inlinevirtual

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

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DataAlloc()

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.

◆ demote()

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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject()

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ 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_8::FrVect::expandToBuffer ( data_type Dest,
nBytes_type DestNBytes 
) const
protected

◆ GetClass()

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetCompress()

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

Retrieve the compression algorithm number.

Returns
The compression algorithm number.

◆ GetData()

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

◆ GetDataRaw() [1/2]

FrVect::data_type FrVect::GetDataRaw ( ) const

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataRaw() [2/2]

FrVect::data_type FrVect::GetDataRaw ( )

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataType() [1/13]

template<class T >
static type_type FrameCPP::Version_8::FrVect::GetDataType ( )
static

◆ GetDataType() [2/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [3/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [4/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [5/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [6/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [7/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [8/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [9/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [10/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [11/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [12/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataType() [13/13]

template<>
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType ( )

◆ GetDataUncompressed() [1/2]

FrVect::data_type FrVect::GetDataUncompressed ( )

Retrieve the pointer to the uncompressed data.

Returns
The pointer to the uncompressed data.

◆ GetDataUncompressed() [2/2]

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.

◆ GetDescription()

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDim() [1/2]

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

◆ GetDim() [2/2]

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

Retrieve the Nth dimension.

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

◆ GetDims()

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

Retrieve all the dimension information.

Returns
The colletion of dimension data

◆ GetName()

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

Retrieve the channel name.

Returns
The channel name

◆ GetNBytes()

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.

◆ GetNData()

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.

◆ GetNDim()

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

Retrieve the number of dimensions.

Returns
The number of dimensions

◆ GetType()

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

Retrieve the vector class.

Returns
The vector class.

◆ GetTypeSize() [1/2]

size_t FrameCPP::Version_8::FrVect::GetTypeSize ( ) const
inline

◆ GetTypeSize() [2/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.

◆ GetUnitY()

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

◆ Merge()

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

◆ MimeData()

void FrVect::MimeData ( const std::string &  MimeType,
void *  Data,
nBytes_type  DataSize 
)

Set the current FrVect with the MIME data.

◆ ObjectStructName()

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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator!=()

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

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

◆ operator==() [1/2]

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

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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ pBytes()

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< Common::FrameSpec::Object, checksum_type >.

◆ pCreate()

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< Common::FrameSpec::Object, checksum_type >.

◆ Promote()

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

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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/3]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/3]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/3]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited

◆ pWrite()

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< Common::FrameSpec::Object, checksum_type >.

◆ SetName()

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

◆ SetNData()

void FrameCPP::Version_8::FrVect::SetNData ( nData_type  NData)
inline

◆ SetUnitY()

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

◆ StructDescription()

const Description * FrVect::StructDescription ( )
static

The description of structure.

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

◆ StructName()

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.

◆ SubFrVect()

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

◆ Uncompress()

void FrVect::Uncompress ( )

◆ VerifyObject()

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.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Write()

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext()

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

◆ DEFAULT_GZIP_LEVEL

const int FrVect::DEFAULT_GZIP_LEVEL
static

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