ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_6::FrVect Class Reference

#include <FrVect.hh>

Inheritance diagram for FrameCPP::Version_6::FrVect:
Collaboration diagram for FrameCPP::Version_6::FrVect:

Classes

struct  data_definition_type

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 ) , ZERO_SUPPRESS_SHORT_GZIP_OTHER = 6 , ZERO_SUPPRESS_OTHERWISE_GZIP = 10 ,
  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 ) , ZERO_SUPPRESS_SHORT_GZIP_OTHER = 6 ,
  ZERO_SUPPRESS_OTHERWISE_GZIP = 10 , 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
}
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 ) , ZERO_SUPPRESS_SHORT_GZIP_OTHER = 6 , ZERO_SUPPRESS_OTHERWISE_GZIP = 10 ,
  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 ) , ZERO_SUPPRESS_SHORT_GZIP_OTHER = 6 ,
  ZERO_SUPPRESS_OTHERWISE_GZIP = 10 , 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 INT_2U compress_type
typedef INT_2U type_type
typedef INT_8U nData_type
typedef INT_8U nBytes_type
typedef INT_4U 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::unique_ptr< FrVectsubfrvect_type
typedef INT_2U compress_type
typedef INT_2U type_type
typedef INT_8U nData_type
typedef INT_8U nBytes_type
typedef INT_4U 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::unique_ptr< FrVectsubfrvect_type
typedef FrameSpec::version_type frame_spec_version_type
typedef FrameSpec::version_type frame_spec_version_type
typedef boost::shared_ptr< Objectobject_type
typedef boost::shared_ptr< Objectobject_type
typedef std::unique_ptr< Objectunique_object_type
typedef std::unique_ptr< Objectunique_object_type
typedef object_type demote_arg_type
typedef object_type demote_arg_type
typedef object_type demote_ret_type
typedef object_type demote_ret_type
typedef stream_base_type demote_stream_type
typedef stream_base_type demote_stream_type
typedef object_type promote_arg_type
typedef object_type promote_arg_type
typedef object_type promote_ret_type
typedef object_type promote_ret_type
typedef stream_base_type promote_stream_type
typedef stream_base_type promote_stream_type
typedef INT_4U cmn_compression_scheme_type
typedef INT_4U cmn_compression_scheme_type
typedef INT_2U cmn_compression_level_type
typedef INT_2U cmn_compression_level_type

Public Member Functions

 FrVect ()
 FrVect (const FrVect &Source)
 Copy 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, INT_2U type, INT_4U nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, const void *data=0, const std::string &unitY="")
 exc: std::bad_alloc - Memory allocation failed.
 FrVect (const std::string &name, INT_2U type, INT_4U nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, void *data=0, const std::string &unitY="")
 exc: std::bad_alloc - Memory allocation failed.
 FrVect (const std::string &name, compress_type Compress, type_type type, nDim_type nDim, const Dimension *dims, nData_type NData, nBytes_type NBytes, void *data, const std::string &unitY="")
template<class T>
 FrVect (const std::string &name, INT_4U nDim=1, const Dimension *dims=0, const T *data=0, const std::string &unitY="")
 exc: std::bad_alloc - Memory allocation failed.
template<class T>
 FrVect (const std::string &name, INT_4U nDim=1, const Dimension *dims=0, T *data=0, const std::string &unitY="")
 exc: std::bad_alloc - Memory allocation failed.
 FrVect (const Previous::FrVect &Source, stream_base_type *Stream)
virtual ~FrVect ()
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
bool operator== (const FrVect &RHS) const
bool operator!= (const FrVect &RHS) const
FrVectoperator+= (const FrVect &RHS)
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
FrameCPP::cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object.
const std::string & GetName () const
INT_2U GetCompress () const
INT_2U GetType () const
INT_8U GetNData () const
INT_8U GetNBytes () const
data_type GetData () const
data_type GetDataRaw () const
data_type GetDataRaw ()
data_type GetDataUncompressed ()
data_pointer_type GetDataUncompressed (boost::shared_array< CHAR_U > &Expanded) const
INT_4U GetNDim () const
const DimensionGetDim (nDim_type Offset) const
DimensionGetDim (nDim_type Offset)
const std::string GetUnitY () const
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.
void SetNData (INT_4U NData)
size_t GetTypeSize () const
FrVectMerge (const FrVect &RHS)
subfrvect_type SubFrVect (INT_4U Start, INT_4U Stop) const
virtual FrVectCreate (istream_type &Stream) const
 constructor - virtual
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the integrity of the object.
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 FrVect ()
 FrVect (const FrVect &Source)
 Copy 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, INT_2U type, INT_4U nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, const void *data=0, const std::string &unitY="")
 exc: std::bad_alloc - Memory allocation failed.
 FrVect (const std::string &name, INT_2U type, INT_4U nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, void *data=0, const std::string &unitY="")
 exc: std::bad_alloc - Memory allocation failed.
 FrVect (const std::string &name, compress_type Compress, type_type type, nDim_type nDim, const Dimension *dims, nData_type NData, nBytes_type NBytes, void *data, const std::string &unitY="")
template<class T>
 FrVect (const std::string &name, INT_4U nDim=1, const Dimension *dims=0, const T *data=0, const std::string &unitY="")
 exc: std::bad_alloc - Memory allocation failed.
template<class T>
 FrVect (const std::string &name, INT_4U nDim=1, const Dimension *dims=0, T *data=0, const std::string &unitY="")
 exc: std::bad_alloc - Memory allocation failed.
 FrVect (const Previous::FrVect &Source, stream_base_type *Stream)
virtual ~FrVect ()
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
bool operator== (const FrVect &RHS) const
bool operator!= (const FrVect &RHS) const
FrVectoperator+= (const FrVect &RHS)
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
FrameCPP::cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object.
const std::string & GetName () const
INT_2U GetCompress () const
INT_2U GetType () const
INT_8U GetNData () const
INT_8U GetNBytes () const
data_type GetData () const
data_type GetDataRaw () const
data_type GetDataRaw ()
data_type GetDataUncompressed ()
data_pointer_type GetDataUncompressed (boost::shared_array< CHAR_U > &Expanded) const
INT_4U GetNDim () const
const DimensionGetDim (nDim_type Offset) const
DimensionGetDim (nDim_type Offset)
const std::string GetUnitY () const
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.
void SetNData (INT_4U NData)
size_t GetTypeSize () const
FrVectMerge (const FrVect &RHS)
subfrvect_type SubFrVect (INT_4U Start, INT_4U Stop) const
virtual FrVectCreate (istream_type &Stream) const
 constructor - virtual
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the integrity of the object.
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 ObjectCreate () const
 constructor - virtual
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
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)

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
static const char * StructName ()
static const Common::DescriptionStructDescription ()
template<class T>
static INT_2U GetDataType ()
static size_t GetTypeSize (INT_2U type)
 param: INT_2U type - Data type ID.
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
static const char * StructName ()
static const Common::DescriptionStructDescription ()
template<class T>
static INT_2U GetDataType ()
static size_t GetTypeSize (INT_2U type)
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
template<>
INT_2U GetDataType ()
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 Public Attributes

static const int DEFAULT_GZIP_LEVEL

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
void expandToBuffer (boost::shared_array< CHAR_U > &Dest, INT_8U &DestNBytes) const
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
void expandToBuffer (boost::shared_array< CHAR_U > &Dest, INT_8U &DestNBytes) const
virtual class_type getClass () const
 Retrieve the class identifier.
virtual class_type getClass () const
 Retrieve the class identifier.
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 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

Private Member Functions

 FrVect (istream_type &Stream)
void data_alloc (nBytes_type NBytes)
void data_copy (data_const_pointer_type Data, nBytes_type NBytes)
 FrVect (istream_type &Stream)
void data_alloc (nBytes_type NBytes)
void data_copy (data_const_pointer_type Data, nBytes_type NBytes)

Private Attributes

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

Member Typedef Documentation

◆ cmn_compression_level_type [1/2]

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

◆ cmn_compression_level_type [2/2]

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

◆ cmn_compression_scheme_type [1/2]

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

◆ cmn_compression_scheme_type [2/2]

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

◆ compress_type [1/2]

typedef INT_2U FrameCPP::Version_6::FrVect::compress_type

◆ compress_type [2/2]

typedef INT_2U FrameCPP::Version_6::FrVect::compress_type

◆ data_const_pointer_type [1/2]

typedef const data_element_type* FrameCPP::Version_6::FrVect::data_const_pointer_type

◆ data_const_pointer_type [2/2]

typedef const data_element_type* FrameCPP::Version_6::FrVect::data_const_pointer_type

◆ data_element_type [1/2]

typedef data_type::element_type FrameCPP::Version_6::FrVect::data_element_type

◆ data_element_type [2/2]

typedef data_type::element_type FrameCPP::Version_6::FrVect::data_element_type

◆ data_pointer_type [1/2]

typedef data_element_type* FrameCPP::Version_6::FrVect::data_pointer_type

◆ data_pointer_type [2/2]

typedef data_element_type* FrameCPP::Version_6::FrVect::data_pointer_type

◆ data_type [1/2]

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

◆ data_type [2/2]

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

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ demote_stream_type [1/2]

◆ demote_stream_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ nBytes_type [1/2]

typedef INT_8U FrameCPP::Version_6::FrVect::nBytes_type

◆ nBytes_type [2/2]

typedef INT_8U FrameCPP::Version_6::FrVect::nBytes_type

◆ nData_type [1/2]

typedef INT_8U FrameCPP::Version_6::FrVect::nData_type

◆ nData_type [2/2]

typedef INT_8U FrameCPP::Version_6::FrVect::nData_type

◆ nDim_type [1/2]

typedef INT_4U FrameCPP::Version_6::FrVect::nDim_type

◆ nDim_type [2/2]

typedef INT_4U FrameCPP::Version_6::FrVect::nDim_type

◆ object_type [1/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ object_type [2/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ promote_stream_type [1/2]

◆ promote_stream_type [2/2]

◆ subfrvect_type [1/2]

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

◆ subfrvect_type [2/2]

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

◆ type_type [1/2]

typedef INT_2U FrameCPP::Version_6::FrVect::type_type

◆ type_type [2/2]

typedef INT_2U FrameCPP::Version_6::FrVect::type_type

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

Member Enumeration Documentation

◆ compression_scheme_type [1/2]

enum FrameCPP::Version_6::FrVect::compression_scheme_type
Enumerator
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_SHORT_GZIP_OTHER 
ZERO_SUPPRESS_OTHERWISE_GZIP 
NONE 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_SHORT_GZIP_OTHER 
ZERO_SUPPRESS_OTHERWISE_GZIP 
NONE 

◆ compression_scheme_type [2/2]

enum FrameCPP::Version_6::FrVect::compression_scheme_type
Enumerator
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_SHORT_GZIP_OTHER 
ZERO_SUPPRESS_OTHERWISE_GZIP 
NONE 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_SHORT_GZIP_OTHER 
ZERO_SUPPRESS_OTHERWISE_GZIP 
NONE 

◆ data_types_type [1/2]

enum FrameCPP::Version_6::FrVect::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 

◆ data_types_type [2/2]

enum FrameCPP::Version_6::FrVect::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/20]

FrameCPP::Version_6::FrVect::FrVect ( )

◆ FrVect() [2/20]

FrameCPP::Version_6::FrVect::FrVect ( const FrVect & Source)

Copy Constructor.

Parameters
[in]SourceSource vector.

◆ FrVect() [3/20]

FrameCPP::Version_6::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() [4/20]

FrameCPP::Version_6::FrVect::FrVect ( const std::string & name,
INT_2U type,
INT_4U nDim,
const Dimension * dims,
const byte_order_type byte_order = BYTE_ORDER_HOST,
const void * data = 0,
const std::string & unitY = "" )
explicit

exc: std::bad_alloc - Memory allocation failed.

param: const std::string& name - The name of the data. param: INT_2U type - The data type. param: INT_4U nDim - The number of dimensions. param: const Dimension* dims - A pointer to 'nDim' Dimension objects

param: const byte_order_type byte_order - Byte order of the data. Default

param: const void* data - A pointer to the data. Default: 0 param: const std::string& unitY - Units for the data. Default: ""

◆ FrVect() [5/20]

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

exc: std::bad_alloc - Memory allocation failed.

param: const std::string& name - The name of the data. param: INT_2U type - The data type. param: INT_4U nDim - The number of dimensions. param: const Dimension* dims - A pointer to 'nDim' Dimension objects

param: const byte_order_type byte_order - Byte order of the data.

param: const void* data - A pointer to the data. Default: 0 param: const std::string& unitY - Units for the data. Default: "" param: bool allocate - Whether to allocate data. Default: true. param: bool owns - Whether to destruct data in the destructor.

◆ FrVect() [6/20]

FrameCPP::Version_6::FrVect::FrVect ( const std::string & name,
compress_type Compress,
type_type type,
nDim_type nDim,
const Dimension * dims,
nData_type NData,
nBytes_type NBytes,
void * data,
const std::string & unitY = "" )
explicit

◆ FrVect() [7/20]

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

exc: std::bad_alloc - Memory allocation failed.

◆ FrVect() [8/20]

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

exc: std::bad_alloc - Memory allocation failed.

◆ FrVect() [9/20]

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

◆ ~FrVect() [1/2]

FrameCPP::Version_6::FrVect::~FrVect ( )
virtual

Reimplemented from FrameCPP::Common::FrVect.

◆ FrVect() [10/20]

FrameCPP::Version_6::FrVect::FrVect ( istream_type & Stream)
private

◆ FrVect() [11/20]

FrameCPP::Version_6::FrVect::FrVect ( )

◆ FrVect() [12/20]

FrameCPP::Version_6::FrVect::FrVect ( const FrVect & Source)

Copy Constructor.

Parameters
[in]SourceSource vector.

◆ FrVect() [13/20]

FrameCPP::Version_6::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() [14/20]

FrameCPP::Version_6::FrVect::FrVect ( const std::string & name,
INT_2U type,
INT_4U nDim,
const Dimension * dims,
const byte_order_type byte_order = BYTE_ORDER_HOST,
const void * data = 0,
const std::string & unitY = "" )
explicit

exc: std::bad_alloc - Memory allocation failed.

param: const std::string& name - The name of the data. param: INT_2U type - The data type. param: INT_4U nDim - The number of dimensions. param: const Dimension* dims - A pointer to 'nDim' Dimension objects

param: const byte_order_type byte_order - Byte order of the data. Default

param: const void* data - A pointer to the data. Default: 0 param: const std::string& unitY - Units for the data. Default: ""

◆ FrVect() [15/20]

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

exc: std::bad_alloc - Memory allocation failed.

param: const std::string& name - The name of the data. param: INT_2U type - The data type. param: INT_4U nDim - The number of dimensions. param: const Dimension* dims - A pointer to 'nDim' Dimension objects

param: const byte_order_type byte_order - Byte order of the data.

param: const void* data - A pointer to the data. Default: 0 param: const std::string& unitY - Units for the data. Default: "" param: bool allocate - Whether to allocate data. Default: true. param: bool owns - Whether to destruct data in the destructor.

◆ FrVect() [16/20]

FrameCPP::Version_6::FrVect::FrVect ( const std::string & name,
compress_type Compress,
type_type type,
nDim_type nDim,
const Dimension * dims,
nData_type NData,
nBytes_type NBytes,
void * data,
const std::string & unitY = "" )
explicit

◆ FrVect() [17/20]

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

exc: std::bad_alloc - Memory allocation failed.

◆ FrVect() [18/20]

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

exc: std::bad_alloc - Memory allocation failed.

◆ FrVect() [19/20]

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

◆ ~FrVect() [2/2]

virtual FrameCPP::Version_6::FrVect::~FrVect ( )
virtual

Reimplemented from FrameCPP::Common::FrVect.

◆ FrVect() [20/20]

FrameCPP::Version_6::FrVect::FrVect ( istream_type & Stream)
private

Member Function Documentation

◆ Bytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_6::FrVect::Bytes ( const Common::StreamBase & Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

◆ Bytes() [2/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_6::FrVect::Bytes ( const Common::StreamBase & Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

◆ 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< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, 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::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, 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::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, 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::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, 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< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, 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::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, 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::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, 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::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ CloneCompressed() [1/2]

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

◆ CloneCompressed() [2/2]

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

◆ Compress() [1/2]

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

◆ Compress() [2/2]

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

◆ CompressData() [1/2]

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

◆ CompressData() [2/2]

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

◆ Compression() [1/2]

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

◆ Compression() [2/2]

virtual Compression::compression_base_type FrameCPP::Version_6::FrVect::Compression ( ) const
virtual

◆ compressToBuffer() [1/2]

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

◆ compressToBuffer() [2/2]

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

◆ Create() [2/4]

◆ Create() [3/4]

FrVect * FrameCPP::Version_6::FrVect::Create ( istream_type & Stream) const
virtual

constructor - virtual

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

◆ Create() [4/4]

virtual FrVect * FrameCPP::Version_6::FrVect::Create ( istream_type & Stream) const
virtual

constructor - virtual

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

◆ data_alloc() [1/2]

void FrameCPP::Version_6::FrVect::data_alloc ( nBytes_type NBytes)
private

◆ data_alloc() [2/2]

void FrameCPP::Version_6::FrVect::data_alloc ( nBytes_type NBytes)
private

◆ data_copy() [1/2]

void FrameCPP::Version_6::FrVect::data_copy ( data_const_pointer_type Data,
nBytes_type NBytes )
private

◆ data_copy() [2/2]

void FrameCPP::Version_6::FrVect::data_copy ( data_const_pointer_type Data,
nBytes_type NBytes )
private

◆ demote() [1/2]

FrVect::demote_ret_type FrameCPP::Version_6::FrVect::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedvirtual

Down grade an object.

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

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_6::FrVect::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedvirtual

Down grade an object.

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

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

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

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

void FrameCPP::Version_6::FrVect::expandToBuffer ( boost::shared_array< CHAR_U > & Dest,
INT_8U & DestNBytes ) const
protected

◆ expandToBuffer() [3/3]

void FrameCPP::Version_6::FrVect::expandToBuffer ( boost::shared_array< CHAR_U > & Dest,
INT_8U & DestNBytes ) const
protected

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

INT_2U FrameCPP::Version_6::FrVect::GetCompress ( ) const
inline

◆ GetCompress() [2/2]

INT_2U FrameCPP::Version_6::FrVect::GetCompress ( ) const

◆ GetData() [1/2]

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

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

See also
GetDataRaw, GetDataUncompressed

◆ GetData() [2/2]

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

◆ GetDataRaw() [1/4]

FrVect::data_type FrameCPP::Version_6::FrVect::GetDataRaw ( )
inline

◆ GetDataRaw() [2/4]

data_type FrameCPP::Version_6::FrVect::GetDataRaw ( )

◆ GetDataRaw() [3/4]

FrVect::data_type FrameCPP::Version_6::FrVect::GetDataRaw ( ) const
inline

◆ GetDataRaw() [4/4]

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

◆ GetDataType() [1/14]

template<class T>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [2/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [3/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [4/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [5/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [6/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [7/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [8/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [9/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [10/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [11/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [12/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [13/14]

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataType() [14/14]

template<class T>
INT_2U FrameCPP::Version_6::FrVect::GetDataType ( )
static

◆ GetDataUncompressed() [1/4]

FrVect::data_type FrameCPP::Version_6::FrVect::GetDataUncompressed ( )
inline

◆ GetDataUncompressed() [2/4]

data_type FrameCPP::Version_6::FrVect::GetDataUncompressed ( )

◆ GetDataUncompressed() [3/4]

FrVect::data_pointer_type FrameCPP::Version_6::FrVect::GetDataUncompressed ( boost::shared_array< CHAR_U > & Expanded) const

◆ GetDataUncompressed() [4/4]

data_pointer_type FrameCPP::Version_6::FrVect::GetDataUncompressed ( boost::shared_array< CHAR_U > & Expanded) const

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

◆ GetDescription() [4/4]

◆ GetDim() [1/4]

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

◆ GetDim() [2/4]

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

◆ GetDim() [3/4]

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

◆ GetDim() [4/4]

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

◆ GetName() [1/2]

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

◆ GetName() [2/2]

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

◆ GetNBytes() [1/2]

INT_8U FrameCPP::Version_6::FrVect::GetNBytes ( ) const
inline

◆ GetNBytes() [2/2]

INT_8U FrameCPP::Version_6::FrVect::GetNBytes ( ) const

◆ GetNData() [1/2]

INT_8U FrameCPP::Version_6::FrVect::GetNData ( ) const

◆ GetNData() [2/2]

INT_8U FrameCPP::Version_6::FrVect::GetNData ( ) const

◆ GetNDim() [1/2]

INT_4U FrameCPP::Version_6::FrVect::GetNDim ( ) const
inline

◆ GetNDim() [2/2]

INT_4U FrameCPP::Version_6::FrVect::GetNDim ( ) const

◆ GetType() [1/2]

INT_2U FrameCPP::Version_6::FrVect::GetType ( ) const
inline

◆ GetType() [2/2]

INT_2U FrameCPP::Version_6::FrVect::GetType ( ) const

◆ GetTypeSize() [1/4]

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

◆ GetTypeSize() [2/4]

size_t FrameCPP::Version_6::FrVect::GetTypeSize ( ) const

◆ GetTypeSize() [3/4]

size_t FrameCPP::Version_6::FrVect::GetTypeSize ( INT_2U type)
static

param: INT_2U type - Data type ID.

return: INT_2U - Data size. exc: None.

◆ GetTypeSize() [4/4]

size_t FrameCPP::Version_6::FrVect::GetTypeSize ( INT_2U type)
static

◆ GetUnitY() [1/2]

const std::string FrameCPP::Version_6::FrVect::GetUnitY ( ) const
inline

◆ GetUnitY() [2/2]

const std::string FrameCPP::Version_6::FrVect::GetUnitY ( ) const

◆ Merge() [1/2]

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

◆ Merge() [2/2]

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

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_6::FrVect::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_6::FrVect::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ operator!=() [1/2]

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

◆ operator!=() [2/2]

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

◆ operator+=() [1/2]

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

◆ operator+=() [2/2]

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

◆ operator==() [1/4]

bool FrameCPP::Version_6::FrVect::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

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

◆ operator==() [2/4]

virtual bool FrameCPP::Version_6::FrVect::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

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

◆ operator==() [3/4]

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

◆ operator==() [4/4]

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

◆ Promote() [1/2]

FrVect::promote_ret_type FrameCPP::Version_6::FrVect::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

◆ Promote() [2/2]

promote_ret_type FrameCPP::Version_6::FrVect::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
static

◆ promote() [1/2]

FrVect::promote_ret_type FrameCPP::Version_6::FrVect::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedvirtual

Upgrade an object.

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

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_6::FrVect::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedvirtual

Upgrade an object.

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

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

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

◆ SetName() [1/2]

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

Establish the channel name.

Assign a new value for the channel name.

Parameters
[in]NameThe channel name

◆ SetName() [2/2]

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

Establish the channel name.

Parameters
[in]NameThe channel name

◆ SetNData() [1/2]

void FrameCPP::Version_6::FrVect::SetNData ( INT_4U NData)
inline

◆ SetNData() [2/2]

void FrameCPP::Version_6::FrVect::SetNData ( INT_4U NData)

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_6::FrVect::StructDescription ( )
static

◆ StructDescription() [2/2]

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

◆ StructName() [1/2]

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

◆ StructName() [2/2]

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

◆ SubFrVect() [1/2]

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

◆ SubFrVect() [2/2]

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

◆ Uncompress() [1/2]

void FrameCPP::Version_6::FrVect::Uncompress ( )

◆ Uncompress() [2/2]

void FrameCPP::Version_6::FrVect::Uncompress ( )

◆ VerifyObject() [1/2]

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

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.

◆ VerifyObject() [2/2]

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

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]

void FrameCPP::Version_6::FrVect::Write ( ostream_type & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

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

◆ Write() [2/2]

virtual void FrameCPP::Version_6::FrVect::Write ( ostream_type & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

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

const int FrameCPP::Version_6::FrVect::DEFAULT_GZIP_LEVEL
static

◆ 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_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_6::FrVect::m_data
private

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


The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version6/FrVect.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version6/FrVect.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version6/FrVect.cc