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

#include <FrVect.hh>

Inheritance diagram for FrameCPP::Version_6::FrVect:
FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrVect FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

enum  compression_scheme_type {
  CST_DECL =( RAW, 0 ), CST_DECL =( RAW, 0 ), CST_DECL =( RAW, 0 ), CST_DECL =( RAW, 0 ),
  CST_DECL =( RAW, 0 ), CST_DECL =( RAW, 0 ), 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
}
 
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 boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef INT_4U cmn_compression_scheme_type
 
typedef INT_2U cmn_compression_level_type
 

Public Member Functions

 FrVect ()
 
 FrVect (const FrVect &Source)
 Copy Constructor. More...
 
 FrVect (const std::string &name, compress_type Compress, type_type type, nDim_type nDim, const Dimension *dims, nData_type NData, nBytes_type NBytes, data_type data, const std::string &unitY="")
 
 FrVect (const std::string &name, 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. More...
 
 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. More...
 
 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. More...
 
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. More...
 
 FrVect (const Previous::FrVect &Source, istream_type *Stream)
 
virtual ~FrVect ()
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
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 More...
 
FrameCPP::cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
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. More...
 
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 More...
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the integrity of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
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 ()
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_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. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 

Static Public Attributes

static const int DEFAULT_GZIP_LEVEL
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
void expandToBuffer (boost::shared_array< CHAR_U > &Dest, INT_8U &DestNBytes) const
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
void compressToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::compress_type_reverse_mapping &CompressionReverseMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, Compression::output_type &Dest, INT_8U &DestNBytes, INT_4U &DestCompressionMode, const INT_4U Level) const
 
void expandToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, const INT_4U SourceByteOrder, Compression::output_type &Dest, INT_8U &DestNBytes) const
 

Member Typedef Documentation

◆ cmn_compression_level_type

◆ cmn_compression_scheme_type

◆ compress_type

◆ data_const_pointer_type

◆ data_element_type

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

◆ data_pointer_type

◆ data_type

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

◆ demote_arg_type

◆ demote_ret_type

◆ frame_spec_version_type

◆ nBytes_type

◆ nData_type

◆ nDim_type

◆ object_type

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

◆ promote_arg_type

◆ promote_ret_type

◆ subfrvect_type

◆ type_type

◆ unique_object_type

Member Enumeration Documentation

◆ compression_scheme_type

Enumerator
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
CST_DECL 
ZERO_SUPPRESS_SHORT_GZIP_OTHER 
ZERO_SUPPRESS_OTHERWISE_GZIP 
NONE 

◆ data_types_type

Enumerator
FR_VECT_C 
FR_VECT_2S 
FR_VECT_8R 
FR_VECT_4R 
FR_VECT_4S 
FR_VECT_8S 
FR_VECT_8C 
FR_VECT_16C 
FR_VECT_STRING 
FR_VECT_2U 
FR_VECT_4U 
FR_VECT_8U 
FR_VECT_1U 

Constructor & Destructor Documentation

◆ FrVect() [1/9]

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

◆ FrVect() [2/9]

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

Copy Constructor.

Parameters
[in]SourceSource vector.

◆ FrVect() [3/9]

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

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

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

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

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

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

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

◆ ~FrVect()

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

Reimplemented from FrameCPP::Common::FrVect.

Member Function Documentation

◆ Bytes()

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

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

◆ CloneCompressed()

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

◆ Compress()

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

◆ CompressData()

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

◆ Compression()

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

◆ compressToBuffer()

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

◆ Create() [1/3]

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

◆ Create() [2/3]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ Create() [3/3]

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

constructor - virtual

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

◆ demote()

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

Down grade an object.

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

◆ DemoteObject()

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

Down grade an object.

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

◆ expandToBuffer() [1/2]

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

◆ expandToBuffer() [2/2]

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

◆ GetClass()

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

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

Retrieve the class identifier.

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

◆ GetCompress()

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

◆ GetData()

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

◆ GetDataRaw() [1/2]

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

◆ GetDataRaw() [2/2]

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

◆ GetDataType() [1/13]

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

◆ GetDataType() [2/13]

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

◆ GetDataType() [3/13]

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

◆ GetDataType() [4/13]

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

◆ GetDataType() [5/13]

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

◆ GetDataType() [6/13]

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

◆ GetDataType() [7/13]

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

◆ GetDataType() [8/13]

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

◆ GetDataType() [9/13]

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

◆ GetDataType() [10/13]

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

◆ GetDataType() [11/13]

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

◆ GetDataType() [12/13]

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

◆ GetDataType() [13/13]

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

◆ GetDataUncompressed() [1/2]

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

◆ GetDataUncompressed() [2/2]

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

◆ GetDescription()

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDim() [1/2]

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

◆ GetDim() [2/2]

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

◆ GetName()

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

◆ GetNBytes()

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

◆ GetNData()

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

◆ GetNDim()

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

◆ GetType()

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

◆ GetTypeSize() [1/2]

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

◆ GetTypeSize() [2/2]

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.

◆ GetUnitY()

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

◆ Merge()

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

◆ ObjectStructName()

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

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

◆ operator+=()

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

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

comparison operator

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

◆ Promote()

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

◆ promote()

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

Upgrade an object.

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

◆ PromoteObject() [1/3]

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

Upgrade an object.

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

◆ PromoteObject() [2/3]

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

Upgrade an object.

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

◆ PromoteObject() [3/3]

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

◆ SetName()

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

◆ SetNData()

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

◆ StructDescription()

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

◆ StructName()

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

◆ SubFrVect()

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

◆ Uncompress()

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

◆ VerifyObject()

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.

◆ Write()

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

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

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