ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrVect Class Referenceabstract

Vector Data Structure Definition. More...

#include <FrVect.hh>

Inheritance diagram for FrameCPP::Version_8::FrVect:
Collaboration diagram for FrameCPP::Version_8::FrVect:

Public Types

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 stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 
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 ,
  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 , FR_VECT_C = 0 , FR_VECT_2S = 1 , FR_VECT_8R = 2 ,
  FR_VECT_4R = 3 , FR_VECT_4S = 4 , FR_VECT_8S = 5 , FR_VECT_8C = 6 ,
  FR_VECT_16C = 7 , FR_VECT_STRING = 8 , FR_VECT_2U = 9 , FR_VECT_4U = 10 ,
  FR_VECT_8U = 11 , FR_VECT_1U = 12
}
 
typedef std::string name_type
 
typedef std::string unit_y_type
 
typedef FR_VECT_COMPRESS_TYPE compress_type
 
typedef FR_VECT_COMPRESSION_LEVEL_TYPE compression_level_type
 
typedef FR_VECT_TYPE_TYPE type_type
 
typedef FR_VECT_NDATA_TYPE nData_type
 
typedef FR_VECT_NBYTES_TYPE nBytes_type
 
typedef FR_VECT_NDIM_TYPE nDim_type
 
typedef boost::shared_array< CHAR_U > data_type
 
typedef data_type::element_type data_element_type
 
typedef data_element_typedata_pointer_type
 
typedef const data_element_typedata_const_pointer_type
 
typedef std::vector< Dimensiondimension_container_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 
typedef INT_4U cmn_compression_scheme_type
 
typedef INT_2U cmn_compression_level_type
 

Public Member Functions

const name_typeGetName () const
 Retrieve the name of message, error flag, or alarm state.
 
 FrVect ()
 Default constructor.
 
 FrVect (const FrVect &vect)
 Copy Constructor.
 
 FrVect (const std::string &name, type_type type, nDim_type nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, const void *data=0, const std::string &unitY="")
 Constructor.
 
 FrVect (const std::string &name, compress_type Compress, type_type type, nDim_type nDim, const Dimension *dims, nData_type NData, nBytes_type NBytes, data_type Data, const std::string &unitY="")
 
 FrVect (const std::string &Name, type_type Type, nDim_type NDim, const Dimension *Dims, const std::string &UnitY)
 Constructor.
 
template<class T >
 FrVect (const std::string &name, nDim_type nDim=1, const Dimension *dims=0, const T *data=0, const std::string &unitY="")
 
template<class T >
 FrVect (const std::string &name, nDim_type nDim=1, const Dimension *dims=0, T *data=0, const std::string &unitY="")
 
 FrVect (const Previous::FrVect &Source, stream_base_type *Stream)
 Promotion Constructor.
 
virtual ~FrVect ()
 Destructor.
 
subfrvect_type SubFrVect (INT_4U Start, INT_4U Stop) const
 Request a subset of the data.
 
bool operator== (const FrVect &RHS) const
 equality operator
 
bool operator!= (const FrVect &RHS) const
 inequality operator
 
FrVectoperator+= (const FrVect &RHS)
 Concatinate with another FrAdcData.
 
FrVectMerge (const FrVect &RHS)
 Merge with another FrAdcData.
 
const name_typeGetName () const
 Retrieve the name of message, error flag, or alarm state.
 
 FrVect ()
 Default constructor.
 
 FrVect (const FrVect &vect)
 Copy Constructor.
 
 FrVect (const std::string &name, type_type type, nDim_type nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, const void *data=0, const std::string &unitY="")
 Constructor.
 
 FrVect (const std::string &name, compress_type Compress, type_type type, nDim_type nDim, const Dimension *dims, nData_type NData, nBytes_type NBytes, data_type Data, const std::string &unitY="")
 
 FrVect (const std::string &Name, type_type Type, nDim_type NDim, const Dimension *Dims, const std::string &UnitY)
 Constructor.
 
template<class T >
 FrVect (const std::string &name, nDim_type nDim=1, const Dimension *dims=0, const T *data=0, const std::string &unitY="")
 
template<class T >
 FrVect (const std::string &name, nDim_type nDim=1, const Dimension *dims=0, T *data=0, const std::string &unitY="")
 
 FrVect (const Previous::FrVect &Source, stream_base_type *Stream)
 Promotion Constructor.
 
virtual ~FrVect ()
 Destructor.
 
subfrvect_type SubFrVect (INT_4U Start, INT_4U Stop) const
 Request a subset of the data.
 
bool operator== (const FrVect &RHS) const
 equality operator
 
bool operator!= (const FrVect &RHS) const
 inequality operator
 
FrVectoperator+= (const FrVect &RHS)
 Concatinate with another FrAdcData.
 
FrVectMerge (const FrVect &RHS)
 Merge with another FrAdcData.
 
virtual Common::FrameSpec::ObjectCloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const
 
virtual Common::FrameSpec::ObjectCloneCompressed (cmn_compression_scheme_type Scheme, cmn_compression_level_type Level) const
 
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_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.
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
frame_spec_version_type FrameSpecVersion () const
 
frame_spec_version_type FrameSpecVersion () const
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
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, promote_stream_type *Stream)
 
virtual Compression::compression_base_type Compression () const
 
virtual void CompressData (INT_4U Scheme, INT_2U Level)
 
compress_type GetCompress () const
 Retrieve the compression algorithm number.
 
type_type GetType () const
 Retrieve the vector class.
 
size_t GetTypeSize () const
 
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_typeGetDims ()
 Retrieve all the dimension information.
 
const unit_y_typeGetUnitY () const
 Retrieve the description of how to interpret each element.
 
void Compress (compression_scheme_type Scheme, int Level)
 
void Uncompress ()
 Expand compressed data.
 
void MimeData (const std::string &MimeType, void *Data, nBytes_type DataSize)
 Set the current FrVect with the MIME data.
 
void SetName (const name_type &Name)
 Establish the channel name.
 
void SetUnitY (const unit_y_type &UnitY)
 Set the description of how to interpret each element.
 
void SetNData (nData_type NData)
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static const Common::DescriptionStructDescription ()
 
static const Common::DescriptionStructDescription ()
 
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 object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
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.
 
template<class T >
static type_type GetDataType ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 

Static Public Attributes

static const constexpr int DEFAULT_GZIP_LEVEL = 6
 
static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

Protected Types

typedef STRING io_name_type
 
typedef STRING io_unit_y_type
 
enum  {
  MODE_RAW = BIGENDIAN_RAW , MODE_GZIP = BIGENDIAN_GZIP , MODE_DIFF_GZIP = BIGENDIAN_DIFF_GZIP , MODE_ZERO_SUPPRESS_WORD_2 = BIGENDIAN_ZERO_SUPPRESS_WORD_2 ,
  MODE_ZERO_SUPPRESS_WORD_4 = BIGENDIAN_ZERO_SUPPRESS_WORD_4 , MODE_ZERO_SUPPRESS_WORD_8 = BIGENDIAN_ZERO_SUPPRESS_WORD_8
}
 
enum  { MODE_BIGENDIAN = BIGENDIAN_RAW , MODE_LITTLEENDIAN = LITTLEENDIAN_RAW , MODE_HOSTENDIAN = RAW }
 
enum  {
  MODE_RAW = BIGENDIAN_RAW , MODE_GZIP = BIGENDIAN_GZIP , MODE_DIFF_GZIP = BIGENDIAN_DIFF_GZIP , MODE_ZERO_SUPPRESS_WORD_2 = BIGENDIAN_ZERO_SUPPRESS_WORD_2 ,
  MODE_ZERO_SUPPRESS_WORD_4 = BIGENDIAN_ZERO_SUPPRESS_WORD_4 , MODE_ZERO_SUPPRESS_WORD_8 = BIGENDIAN_ZERO_SUPPRESS_WORD_8
}
 
enum  { MODE_BIGENDIAN = BIGENDIAN_RAW , MODE_LITTLEENDIAN = LITTLEENDIAN_RAW , MODE_HOSTENDIAN = RAW }
 

Protected Member Functions

virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the integrity of the object.
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the integrity of the object.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, demote_stream_type *Stream) const =0
 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 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 promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, promote_stream_type *Stream) const =0
 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_typepCreate (istream_type &Stream) const
 Stream constructor.
 
virtual self_typepCreate (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.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
void data_alloc (nBytes_type NBytes)
 
void data_copy (data_const_pointer_type Data, nBytes_type NBytes)
 
void expandToBuffer (data_type &Dest, nBytes_type &DestNBytes) const
 
void expandToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, const INT_4U SourceByteOrder, Compression::output_type &Dest, INT_8U &DestNBytes) const
 
void compressToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::compress_type_reverse_mapping &CompressionReverseMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, Compression::output_type &Dest, INT_8U &DestNBytes, INT_4U &DestCompressionMode, const INT_4U Level) const
 

Static Protected Member Functions

static FrameCPP::Compression::compress_type_mappingcompress_type_map ()
 
static FrameCPP::Compression::compress_type_reverse_mappingcompress_type_reverse_map ()
 
static FrameCPP::Compression::data_type_mappingdata_type_map ()
 

Protected Attributes

data_definition_type m_data
 

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

FrameCPP::cmn_streamsize_type Bytes (const std::vector< Dimension > &Dims)
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
void save (Archive &ar, const unsigned int version) const
 
void save (Archive &ar, const unsigned int version) const
 
void load (Archive &ar, const unsigned int version)
 
void load (Archive &ar, const unsigned int version)
 

Static Private Member Functions

static FrameCPP::cmn_streamsize_type Bytes (const OBJECT_TYPE &Object)
 
static FrameCPP::cmn_streamsize_type Bytes (const OBJECT_TYPE &Object)
 

Private Attributes

checksum_type m_chkSum
 Structure checksum.
 
const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 
const frame_spec_version_type frame_spec_version
 Version of the frame specification.
 

Detailed Description

Vector Data Structure Definition.

Member Typedef Documentation

◆ cmn_compression_level_type

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

◆ cmn_compression_scheme_type

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

◆ compress_type

◆ compression_level_type

◆ data_const_pointer_type

◆ data_element_type

typedef data_type::element_type FrameCPP::Version_8::FrVectImpl::Data::data_element_type
inherited

◆ data_pointer_type

◆ data_type

typedef boost::shared_array< CHAR_U > FrameCPP::Version_8::FrVectImpl::Data::data_type
inherited

◆ demote_arg_type

◆ demote_ret_type

◆ demote_stream_type

◆ dimension_container_type

◆ frame_spec_version_type

◆ io_name_type

typedef STRING FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >::io_name_type
protectedinherited

◆ io_unit_y_type

typedef STRING FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >::io_unit_y_type
protectedinherited

◆ istream_type

◆ name_type

typedef std::string FrameCPP::Version_8::FrVectImpl::Data::name_type
inherited

◆ nBytes_type

◆ nData_type

◆ nDim_type

◆ object_base_type

◆ object_type

◆ ostream_type

◆ promote_arg_type

◆ promote_ret_type

◆ promote_stream_type

◆ self_type

◆ struct_desc_type

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

◆ struct_id_type

template<typename Object_T >
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type

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

◆ subfrvect_type

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

◆ type_type

◆ unique_object_type

◆ unit_y_type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
MODE_RAW 
MODE_GZIP 
MODE_DIFF_GZIP 
MODE_ZERO_SUPPRESS_WORD_2 
MODE_ZERO_SUPPRESS_WORD_4 
MODE_ZERO_SUPPRESS_WORD_8 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
MODE_BIGENDIAN 
MODE_LITTLEENDIAN 
MODE_HOSTENDIAN 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
MODE_RAW 
MODE_GZIP 
MODE_DIFF_GZIP 
MODE_ZERO_SUPPRESS_WORD_2 
MODE_ZERO_SUPPRESS_WORD_4 
MODE_ZERO_SUPPRESS_WORD_8 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
MODE_BIGENDIAN 
MODE_LITTLEENDIAN 
MODE_HOSTENDIAN 

◆ 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 
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 
FR_VECT_C 
FR_VECT_2S 
FR_VECT_8R 
FR_VECT_4R 
FR_VECT_4S 
FR_VECT_8S 
FR_VECT_8C 
FR_VECT_16C 
FR_VECT_STRING 
FR_VECT_2U 
FR_VECT_4U 
FR_VECT_8U 
FR_VECT_1U 

Constructor & Destructor Documentation

◆ FrVect() [1/16]

FrVect::FrVect ( )

Default constructor.

Returns
A new instance of this object.

◆ FrVect() [2/16]

FrVect::FrVect ( const FrVect & vect)

Copy Constructor.

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

◆ FrVect() [3/16]

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

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

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

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

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

FrVect::FrVect ( const Previous::FrVect & Source,
stream_base_type * 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() [1/2]

FrVect::~FrVect ( )
virtual

Destructor.

Reimplemented from FrameCPP::Common::FrVect.

◆ FrVect() [9/16]

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

Default constructor.

Returns
A new instance of this object.

◆ FrVect() [10/16]

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

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

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

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

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

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

FrameCPP::Version_8::FrVect::FrVect ( const Previous::FrVect & Source,
stream_base_type * 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() [2/2]

virtual FrameCPP::Version_8::FrVect::~FrVect ( )
virtual

Destructor.

Reimplemented from FrameCPP::Common::FrVect.

Member Function Documentation

◆ Bytes() [1/4]

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.

◆ Bytes() [2/4]

static FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >::Bytes ( const OBJECT_TYPE & Object)
staticprivateinherited

◆ Bytes() [3/4]

static FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >::Bytes ( const OBJECT_TYPE & Object)
staticprivateinherited

◆ Bytes() [4/4]

FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrVectImpl::ClassicIO< FrameCPP::Version_8::FrVect >::Bytes< std::vector< Dimension > > ( const std::vector< Dimension > & Dims)
privateinherited

◆ CheckSumDataClass() [1/2]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

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

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

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

Comment to be used in comment field of FrSE.

◆ Clone() [1/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Clone() [2/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ CloneCompressed() [1/2]

◆ CloneCompressed() [2/2]

◆ Compress()

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

◆ compress_type_map()

static FrameCPP::Compression::compress_type_mapping & FrameCPP::Version_8::FrVectImpl::Data::compress_type_map ( )
inlinestaticprotectedinherited

◆ compress_type_reverse_map()

static FrameCPP::Compression::compress_type_reverse_mapping & FrameCPP::Version_8::FrVectImpl::Data::compress_type_reverse_map ( )
inlinestaticprotectedinherited

◆ CompressData()

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

◆ Compression()

virtual Compression::compression_base_type FrameCPP::Version_8::FrVectImpl::Data::Compression ( ) const
inlinevirtualinherited

◆ compressToBuffer()

void FrameCPP::Common::FrVect::compressToBuffer ( const Compression::compress_type_mapping & CompressionMapping,
const Compression::compress_type_reverse_mapping & CompressionReverseMapping,
const Compression::data_type_mapping & DataTypeMapping,
const INT_4U DataType,
const INT_8U NData,
const CHAR_U * Source,
const INT_8U SourceNBytes,
const INT_4U SourceCompressionMode,
Compression::output_type & Dest,
INT_8U & DestNBytes,
INT_4U & DestCompressionMode,
const INT_4U Level ) const
protectedinherited

◆ Create() [1/6]

◆ Create() [2/6]

◆ Create() [3/6]

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.

◆ Create() [4/6]

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.

◆ Create() [5/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [6/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ data_alloc()

void FrameCPP::Version_8::FrVectImpl::Data::data_alloc ( nBytes_type NBytes)
inlineprotectedinherited

◆ data_copy()

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

◆ data_type_map()

static FrameCPP::Compression::data_type_mapping & FrameCPP::Version_8::FrVectImpl::Data::data_type_map ( )
inlinestaticprotectedinherited

◆ DataAlloc()

static data_type FrameCPP::Version_8::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]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/3]

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote ( frame_spec_version_type Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedpure virtualinherited

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.

Implemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, and FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >.

◆ demote() [2/3]

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

Demotes object to previous version of the frame spec.

Parameters
[in]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() [3/3]

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

Demotes object to previous version of the frame spec.

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

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_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.

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_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::FrVectImpl::Data::expandToBuffer ( data_type & Dest,
nBytes_type & DestNBytes ) const
inlineprotectedinherited

◆ FrameSpecDescription()

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

Return the dictionary name of the structure.

◆ FrameSpecId()

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

Return the dictionary name of the structure.

◆ FrameSpecName()

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

◆ FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inlineinherited

◆ FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inherited

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

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

Retrieve the class identifier.

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

◆ getClass() [2/2]

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

Retrieve the class identifier.

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

◆ GetCompress()

compress_type FrameCPP::Version_8::FrVectImpl::Data::GetCompress ( ) const
inlineinherited

Retrieve the compression algorithm number.

Returns
The compression algorithm number.

◆ GetData()

data_type FrameCPP::Version_8::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_8::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_8::FrVectImpl::Data::GetDataRaw ( ) const
inlineinherited

Retrieve the pointer to the compressed data.

Returns
The pointer to the compressed data.

◆ GetDataType()

template<class T >
static type_type FrameCPP::Version_8::FrVectImpl::Data::GetDataType ( )
staticinherited

◆ GetDataUncompressed() [1/2]

data_type FrameCPP::Version_8::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_8::FrVectImpl::Data::GetDataUncompressed ( data_type & Expanded) const
inlineinherited

Retrieve the pointer to the uncompressed data.

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

◆ GetDescription() [1/4]

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.

◆ GetDescription() [2/4]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [3/4]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ostream_type & Stream) const
virtualinherited

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

Reimplemented in FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ GetDescription() [4/4]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ostream_type & Stream) const
virtualinherited

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

Reimplemented in FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ GetDim() [1/2]

Dimension & FrameCPP::Version_8::FrVectImpl::Data::GetDim ( nDim_type Offset)
inlineinherited

Retrieve the Nth dimension.

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

◆ GetDim() [2/2]

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

Retrieve the Nth dimension.

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

◆ GetDims()

dimension_container_type & FrameCPP::Version_8::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_8::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_8::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_8::FrVectImpl::Data::GetNData ( ) const
inlineinherited

Retrieve the number of sample elements in data series.

Returns
The number of sample elements in data series.

◆ GetNDim()

nDim_type FrameCPP::Version_8::FrVectImpl::Data::GetNDim ( ) const
inlineinherited

Retrieve the number of dimensions.

Returns
The number of dimensions

◆ GetType()

type_type FrameCPP::Version_8::FrVectImpl::Data::GetType ( ) const
inlineinherited

Retrieve the vector class.

Returns
The vector class.

◆ GetTypeSize() [1/2]

size_t FrameCPP::Version_8::FrVectImpl::Data::GetTypeSize ( ) const
inlineinherited

◆ GetTypeSize() [2/2]

static size_t FrameCPP::Version_8::FrVectImpl::Data::GetTypeSize ( type_type Type)
inlinestaticinherited

Get size of single data point of particular size.

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

◆ GetUnitY()

const unit_y_type & FrameCPP::Version_8::FrVectImpl::Data::GetUnitY ( ) const
inlineinherited

Retrieve the description of how to interpret each element.

Returns
The description of how to interpret each element

◆ load() [1/2]

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

◆ load() [2/2]

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

◆ Merge() [1/2]

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

Merge with another FrAdcData.

Parameters
[in]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

◆ MimeData()

void FrameCPP::Version_8::FrVectImpl::Data::MimeData ( const std::string & MimeType,
void * Data,
nBytes_type DataSize )
inlineinherited

Set the current FrVect with the MIME data.

◆ ObjectStructName() [1/2]

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

The name structure name of this object.

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

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

◆ ObjectStructName() [2/2]

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

The name structure name of this object.

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

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

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

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

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.

◆ operator==() [3/3]

virtual bool FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >::operator== ( const Common::FrameSpec::Object & RHS) const
virtualinherited

equality operator for abstract data type

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

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

◆ pBytes() [1/2]

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

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

◆ pBytes() [2/2]

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

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

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

Stream constructor.

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

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

◆ pCreate() [2/2]

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

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

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

Promote previous version of object to this version.

Parameters
[in]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::FrVectImpl::ClassicIO< FrVect >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestaticinherited

Promote previous version of object to this version.

Parameters
[in]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/3]

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote ( frame_spec_version_type Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedpure virtualinherited

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.

Implemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, and FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >.

◆ promote() [2/3]

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

Promotes object to another version of the frame spec.

Parameters
[in]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() [3/3]

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

Promotes object to another version of the frame spec.

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

◆ PromoteObject() [1/5]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_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/5]

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,
stream_base_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/5]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_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() [4/5]

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

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,
promote_stream_type * Stream )
inherited

◆ pWrite() [1/2]

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

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

◆ pWrite() [2/2]

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

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

◆ save() [1/2]

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

◆ save() [2/2]

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

◆ SetName()

void FrameCPP::Version_8::FrVectImpl::Data::SetName ( const name_type & Name)
inlineinherited

Establish the channel name.

Assign a new value for the channel name.

Parameters
[in]NameThe channel name

◆ SetNData()

void FrameCPP::Version_8::FrVectImpl::Data::SetNData ( nData_type NData)
inlineinherited

◆ SetUnitY()

void FrameCPP::Version_8::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]UnitYNew description
Returns
The description of how to interpret each element

◆ StructDescription() [1/2]

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

◆ StructDescription() [2/2]

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

◆ StructName()

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

◆ SubFrVect() [1/2]

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

Request a subset of the data.

Parameters
[in]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 FrameCPP::Version_8::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]

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

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.

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

◆ VerifyObject() [2/2]

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

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.

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

◆ Write() [1/2]

Write object to the stream.

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

◆ Write() [2/2]

Write object to the stream.

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

◆ WriteNext() [1/2]

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.

◆ WriteNext() [2/2]

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

static const constexpr int FrameCPP::Version_8::FrVectImpl::Data::DEFAULT_GZIP_LEVEL = 6
staticconstexprinherited

◆ frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version
privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

◆ m_chkSum

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_data

data_definition_type FrameCPP::Version_8::FrVectImpl::Data::m_data
protectedinherited

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ struct_desc

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

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