FrameCPP::Version_3::FrVect Class Reference

#include <FrVect.hh>

Inheritance diagram for FrameCPP::Version_3::FrVect:

Collaboration diagram for FrameCPP::Version_3::FrVect:

Classes
struct	data_container_type

Public Types
typedef Common::FrVect::cmn_compression_scheme_type	cmn_compression_scheme_type
typedef Common::FrVect::cmn_compression_level_type	cmn_compression_level_type
typedef INT_2U	compress_type
typedef INT_2U	type_type
typedef INT_4U	nData_type
typedef INT_4U	nBytes_type
typedef INT_4U	nDim_type
typedef boost::shared_array< CHAR_U >	data_type
typedef std::unique_ptr< FrVect >	subfrvect_type
typedef Common::FrVect::cmn_compression_scheme_type	cmn_compression_scheme_type
typedef Common::FrVect::cmn_compression_level_type	cmn_compression_level_type
typedef INT_2U	compress_type
typedef INT_2U	type_type
typedef INT_4U	nData_type
typedef INT_4U	nBytes_type
typedef INT_4U	nDim_type
typedef boost::shared_array< CHAR_U >	data_type
typedef std::unique_ptr< FrVect >	subfrvect_type
typedef FrameSpec::version_type	frame_spec_version_type
typedef FrameSpec::version_type	frame_spec_version_type
typedef boost::shared_ptr< Object >	object_type
typedef boost::shared_ptr< Object >	object_type
typedef std::unique_ptr< Object >	unique_object_type
typedef std::unique_ptr< Object >	unique_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 object_type	promote_arg_type
typedef object_type	promote_arg_type
typedef object_type	promote_ret_type
typedef object_type	promote_ret_type
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	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 {   RAW = 0, GZIP = 1, DIFF = 2, DIFF_GZIP = 3,   RAW = 0, GZIP = 1, DIFF = 2, DIFF_GZIP = 3 }
enum	compression_scheme_type {   RAW = 0, GZIP = 1, DIFF = 2, DIFF_GZIP = 3,   RAW = 0, GZIP = 1, DIFF = 2, DIFF_GZIP = 3 }

Public Member Functions
	FrVect ()
	Default constructor. More...
	FrVect (const FrVect &vect)
	Copy Constructor. More...
	FrVect (const std::string &name, type_type type, nDim_type nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, const void *data=0, const std::string &unitY="")
	Constructor. More...
	FrVect (const std::string &name, type_type type, nDim_type nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, void *data=0, const std::string &unitY="", bool allocate=true, bool owns=true)
	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, void *data, const std::string &unitY="", bool allocate=true, bool owns=true)
	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="")
	Constructor. More...
template<class T >
	FrVect (const std::string &name, nDim_type nDim=1, const Dimension *dims=0, const T *data=0, const std::string &unitY="")
	exc: std::bad_alloc - Memory allocation failed. More...
template<class T >
	FrVect (const std::string &name, nDim_type nDim=1, const Dimension *dims=0, T *data=0, const std::string &unitY="", bool allocate=true, bool owns=true)
	exc: std::bad_alloc - Memory allocation failed. More...
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
FrVect &	operator+= (const FrVect &RHS)
	Concatination operator. More...
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator More...
FrameCPP::cmn_streamsize_type	Bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...
const std::string &	GetName () const
compress_type	GetCompress () const
type_type	GetType () const
nData_type	GetNData () const
nBytes_type	GetNBytes () const
data_type	GetData (bool Decompress=true) const
data_type	GetData (bool Decompress=true)
data_type	GetDataRaw () const
data_type	GetDataRaw ()
nDim_type	GetNDim () const
const Dimension &	GetDim (nDim_type Offset) const
Dimension &	GetDim (nDim_type Offset)
const std::string	GetUnitY () const
void	Compress (compression_scheme_type Scheme, int GZipLevel)
void	Uncompress ()
	Expand compressed data. More...
virtual void	CompressData (cmn_compression_scheme_type Scheme, cmn_compression_level_type GZipLevel)
virtual Compression::compression_base_type	Compression () const
virtual Common::FrameSpec::Object *	CloneCompressed (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
	Get size of single data point of particular size. More...
FrVect &	Merge (const FrVect &RHS)
	Merge with another FrVect. More...
subfrvect_type	SubFrVect (INT_4U Start, INT_4U Stop) const
virtual FrVect *	Create (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 the structure to the stream. More...
void	expandToBuffer (boost::shared_array< CHAR_U > &Dest, INT_8U &DestNBytes) const
	FrVect ()
	Default constructor. More...
	FrVect (const FrVect &vect)
	Copy Constructor. More...
	FrVect (const std::string &name, type_type type, nDim_type nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, const void *data=0, const std::string &unitY="")
	Constructor. More...
	FrVect (const std::string &name, type_type type, nDim_type nDim, const Dimension *dims, const byte_order_type byte_order=BYTE_ORDER_HOST, void *data=0, const std::string &unitY="", bool allocate=true, bool owns=true)
	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, void *data, const std::string &unitY="", bool allocate=true, bool owns=true)
	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="")
	Constructor. More...
template<class T >
	FrVect (const std::string &name, nDim_type nDim=1, const Dimension *dims=0, const T *data=0, const std::string &unitY="")
	exc: std::bad_alloc - Memory allocation failed. More...
template<class T >
	FrVect (const std::string &name, nDim_type nDim=1, const Dimension *dims=0, T *data=0, const std::string &unitY="", bool allocate=true, bool owns=true)
	exc: std::bad_alloc - Memory allocation failed. More...
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
FrVect &	operator+= (const FrVect &RHS)
	Concatination operator. More...
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator More...
FrameCPP::cmn_streamsize_type	Bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...
const std::string &	GetName () const
compress_type	GetCompress () const
type_type	GetType () const
nData_type	GetNData () const
nBytes_type	GetNBytes () const
data_type	GetData (bool Decompress=true) const
data_type	GetData (bool Decompress=true)
data_type	GetDataRaw () const
data_type	GetDataRaw ()
nDim_type	GetNDim () const
const Dimension &	GetDim (nDim_type Offset) const
Dimension &	GetDim (nDim_type Offset)
const std::string	GetUnitY () const
void	Compress (compression_scheme_type Scheme, int GZipLevel)
void	Uncompress ()
	Expand compressed data. More...
virtual void	CompressData (cmn_compression_scheme_type Scheme, cmn_compression_level_type GZipLevel)
virtual Compression::compression_base_type	Compression () const
virtual Common::FrameSpec::Object *	CloneCompressed (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
	Get size of single data point of particular size. More...
FrVect &	Merge (const FrVect &RHS)
	Merge with another FrVect. More...
subfrvect_type	SubFrVect (INT_4U Start, INT_4U Stop) const
virtual FrVect *	Create (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 the structure to the stream. More...
void	expandToBuffer (boost::shared_array< CHAR_U > &Dest, INT_8U &DestNBytes) const
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...
class_type	GetClass () const
	Retrieve the class identifier. More...
const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object. More...
const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object. More...
ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream. More...
ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream. More...
virtual Object *	Create () const
	constructor - virtual More...
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual More...
virtual Object *	Clone () const
	constructor - virtual copy constructor More...
virtual Object *	Clone () 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::Description *	StructDescription ()
template<class T >
static INT_2U	GetDataType ()
static size_t	GetTypeSize (type_type type)
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
static const char *	StructName ()
static const Common::Description *	StructDescription ()
template<class T >
static INT_2U	GetDataType ()
static size_t	GetTypeSize (type_type type)
static object_type	DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
	Down grade an object. 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 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
static const INT_2U	BYTE_SWAP = 0x100

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...
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...
virtual class_type	getClass () const
	Retrieve the class identifier. More...
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	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	copy_data (CHAR_U *Data, INT_8U size)
	FrVect (istream_type &Stream)
void	copy_data (CHAR_U *Data, INT_8U size)

Private Attributes
data_container_type	m_data

Static Private Attributes
static const Common::FrameSpec::Info::frame_object_types	s_object_id = Common::FrameSpec::Info::FSI_FR_VECT

Member Typedef Documentation

cmn_compression_level_type [1/2]

typedef Common::FrVect::cmn_compression_level_type FrameCPP::Version_3::FrVect::cmn_compression_level_type

cmn_compression_level_type [2/2]

typedef Common::FrVect::cmn_compression_level_type FrameCPP::Version_3::FrVect::cmn_compression_level_type

cmn_compression_scheme_type [1/2]

typedef Common::FrVect::cmn_compression_scheme_type FrameCPP::Version_3::FrVect::cmn_compression_scheme_type

cmn_compression_scheme_type [2/2]

typedef Common::FrVect::cmn_compression_scheme_type FrameCPP::Version_3::FrVect::cmn_compression_scheme_type

compress_type [1/2]

typedef INT_2U FrameCPP::Version_3::FrVect::compress_type

compress_type [2/2]

typedef INT_2U FrameCPP::Version_3::FrVect::compress_type

data_type [1/2]

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

data_type [2/2]

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

demote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

demote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

frame_spec_version_type [1/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

frame_spec_version_type [2/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

nBytes_type [1/2]

typedef INT_4U FrameCPP::Version_3::FrVect::nBytes_type

nBytes_type [2/2]

typedef INT_4U FrameCPP::Version_3::FrVect::nBytes_type

nData_type [1/2]

typedef INT_4U FrameCPP::Version_3::FrVect::nData_type

nData_type [2/2]

typedef INT_4U FrameCPP::Version_3::FrVect::nData_type

nDim_type [1/2]

typedef INT_4U FrameCPP::Version_3::FrVect::nDim_type

nDim_type [2/2]

typedef INT_4U FrameCPP::Version_3::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]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

promote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

subfrvect_type [1/2]

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

subfrvect_type [2/2]

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

type_type [1/2]

typedef INT_2U FrameCPP::Version_3::FrVect::type_type

type_type [2/2]

typedef INT_2U FrameCPP::Version_3::FrVect::type_type

unique_object_type [1/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

unique_object_type [2/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

Member Enumeration Documentation

compression_scheme_type [1/2]

enum FrameCPP::Version_3::FrVectCompressionScheme::compression_scheme_type

inherited

Enumerator
RAW
GZIP
DIFF
DIFF_GZIP
RAW
GZIP
DIFF
DIFF_GZIP

compression_scheme_type [2/2]

enum FrameCPP::Version_3::FrVectCompressionScheme::compression_scheme_type

inherited

Enumerator
RAW
GZIP
DIFF
DIFF_GZIP
RAW
GZIP
DIFF
DIFF_GZIP

data_types_type [1/2]

enum FrameCPP::Version_3::FrVectDataTypes::data_types_type

inherited

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_3::FrVectDataTypes::data_types_type

inherited

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

FrameCPP::Version_3::FrVect::FrVect

(

)

Default constructor.

Returns

A new instance of an FrVect.

FrVect() [2/18]

FrameCPP::Version_3::FrVect::FrVect

(

const FrVect &

vect

)

Copy Constructor.

Parameters

[in]

vect

Copied vector.

Exceptions

std::bad_alloc

Memory allocation failed.

Returns

A new instance of an FrVect

FrVect() [3/18]

FrameCPP::Version_3::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]	name	The name of the data.
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	byte_order	Byte order of the data. Default is BIGENDIAN.
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""

Returns

A new instance of an FrVect

Exceptions

std::bad_alloc

Memory allocation failed.

FrVect() [4/18]

FrameCPP::Version_3::FrVect::FrVect	(	const std::string &	name,
		type_type	type,
		nDim_type	nDim,
		const Dimension *	dims,
		const byte_order_type	byte_order = BYTE_ORDER_HOST,
		void *	data = 0,
		const std::string &	unitY = "",
		bool	allocate = true,
		bool	owns = true
	)

Constructor.

Parameters

[in]	name	The name of the data.
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	byte_order	Byte order of the data. Default is BIGENDIAN.
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""
[in]	allocate	Whether to allocate data. Default: true.
[in]	owns	Whether to destruct data in the destructor. Default: true.

Returns

A new instance of an FrVect

Exceptions

std::bad_alloc

Memory allocation failed.

FrVect() [5/18]

FrameCPP::Version_3::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 = "",
		bool	allocate = true,
		bool	owns = true
	)

Constructor.

Parameters

[in]	name	The name of the data.
[in]	Compress
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	NData
[in]	NBytes
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""
[in]	allocate	Whether to allocate data. Default: true.
[in]	owns	Whether to destruct data in the destructor. Default: true.

Returns

A new instance of an FrVect

FrVect() [6/18]

FrameCPP::Version_3::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 = ""
	)

Constructor.

Parameters

[in]	name	The name of the data.
[in]	Compress
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	NData
[in]	NBytes
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""

Returns

A new instance of an FrVect

FrVect() [7/18]

template<class T >

FrameCPP::Version_3::FrVect::FrVect	(	const std::string &	name,
		nDim_type	nDim = 1,
		const Dimension *	dims = 0,
		const T *	data = 0,
		const std::string &	unitY = ""
	)

exc: std::bad_alloc - Memory allocation failed.

FrVect() [8/18]

template<class T >

FrameCPP::Version_3::FrVect::FrVect	(	const std::string &	name,
		nDim_type	nDim = 1,
		const Dimension *	dims = 0,
		T *	data = 0,
		const std::string &	unitY = "",
		bool	allocate = true,
		bool	owns = true
	)

exc: std::bad_alloc - Memory allocation failed.

~FrVect() [1/2]

FrameCPP::Version_3::FrVect::~FrVect ( )

virtual

Reimplemented from FrameCPP::Common::FrVect.

FrVect() [9/18]

FrameCPP::Version_3::FrVect::FrVect ( istream_type &  Stream )

private

FrVect() [10/18]

FrameCPP::Version_3::FrVect::FrVect

(

)

Default constructor.

Returns

A new instance of an FrVect.

FrVect() [11/18]

FrameCPP::Version_3::FrVect::FrVect

(

const FrVect &

vect

)

Copy Constructor.

Parameters

[in]

vect

Copied vector.

Exceptions

std::bad_alloc

Memory allocation failed.

Returns

A new instance of an FrVect

FrVect() [12/18]

FrameCPP::Version_3::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]	name	The name of the data.
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	byte_order	Byte order of the data. Default is BIGENDIAN.
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""

Returns

A new instance of an FrVect

Exceptions

std::bad_alloc

Memory allocation failed.

FrVect() [13/18]

FrameCPP::Version_3::FrVect::FrVect	(	const std::string &	name,
		type_type	type,
		nDim_type	nDim,
		const Dimension *	dims,
		const byte_order_type	byte_order = BYTE_ORDER_HOST,
		void *	data = 0,
		const std::string &	unitY = "",
		bool	allocate = true,
		bool	owns = true
	)

Constructor.

Parameters

[in]	name	The name of the data.
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	byte_order	Byte order of the data. Default is BIGENDIAN.
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""
[in]	allocate	Whether to allocate data. Default: true.
[in]	owns	Whether to destruct data in the destructor. Default: true.

Returns

A new instance of an FrVect

Exceptions

std::bad_alloc

Memory allocation failed.

FrVect() [14/18]

FrameCPP::Version_3::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 = "",
		bool	allocate = true,
		bool	owns = true
	)

Constructor.

Parameters

[in]	name	The name of the data.
[in]	Compress
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	NData
[in]	NBytes
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""
[in]	allocate	Whether to allocate data. Default: true.
[in]	owns	Whether to destruct data in the destructor. Default: true.

Returns

A new instance of an FrVect

FrVect() [15/18]

FrameCPP::Version_3::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 = ""
	)

Constructor.

Parameters

[in]	name	The name of the data.
[in]	Compress
[in]	type	The data type.
[in]	nDim	The number of dimensions.
[in]	dims	A pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
[in]	NData
[in]	NBytes
[in]	data	A pointer to the data. Default: 0
[in]	unitY	Units for the data. Default: ""

Returns

A new instance of an FrVect

FrVect() [16/18]

template<class T >

FrameCPP::Version_3::FrVect::FrVect	(	const std::string &	name,
		nDim_type	nDim = 1,
		const Dimension *	dims = 0,
		const T *	data = 0,
		const std::string &	unitY = ""
	)

exc: std::bad_alloc - Memory allocation failed.

FrVect() [17/18]

template<class T >

FrameCPP::Version_3::FrVect::FrVect	(	const std::string &	name,
		nDim_type	nDim = 1,
		const Dimension *	dims = 0,
		T *	data = 0,
		const std::string &	unitY = "",
		bool	allocate = true,
		bool	owns = true
	)

exc: std::bad_alloc - Memory allocation failed.

~FrVect() [2/2]

virtual FrameCPP::Version_3::FrVect::~FrVect ( )

virtual

Reimplemented from FrameCPP::Common::FrVect.

FrVect() [18/18]

FrameCPP::Version_3::FrVect::FrVect ( istream_type &  Stream )

private

Member Function Documentation

Bytes() [1/2]

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

virtual

Number of bytes needed to write this structure.

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

Bytes() [2/2]

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

virtual

Number of bytes needed to write this structure.

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

Clone() [1/2]

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

virtualinherited

constructor - virtual copy constructor

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

Clone() [2/2]

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

virtualinherited

constructor - virtual copy constructor

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

CloneCompressed() [1/2]

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

virtual

Implements FrameCPP::Common::FrVect.

CloneCompressed() [2/2]

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

virtual

Implements FrameCPP::Common::FrVect.

Compress() [1/2]

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

Compress() [2/2]

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

CompressData() [1/2]

virtual void FrameCPP::Version_3::FrVect::CompressData ( cmn_compression_scheme_type  Scheme, cmn_compression_level_type  GZipLevel  )

virtual

Implements FrameCPP::Common::FrVect.

CompressData() [2/2]

void FrameCPP::Version_3::FrVect::CompressData ( cmn_compression_scheme_type  Scheme, cmn_compression_level_type  GZipLevel  )

virtual

Implements FrameCPP::Common::FrVect.

Compression() [1/2]

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

virtual

Implements FrameCPP::Common::FrVect.

Compression() [2/2]

Compression::compression_base_type FrameCPP::Version_3::FrVect::Compression ( ) const

inlinevirtual

Implements FrameCPP::Common::FrVect.

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

copy_data() [1/2]

void FrameCPP::Version_3::FrVect::copy_data ( CHAR_U *  Data, INT_8U  size  )

private

copy_data() [2/2]

void FrameCPP::Version_3::FrVect::copy_data ( CHAR_U *  Data, INT_8U  size  )

private

Create() [1/4]

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

virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_4::FrTOC, and FrameCPP::Version_4::FrTOC.

Create() [2/4]

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

virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.

Create() [3/4]

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

virtual

constructor - virtual

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

Create() [4/4]

FrVect * FrameCPP::Version_3::FrVect::Create ( istream_type &  Stream ) const

virtual

constructor - virtual

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

demote() [1/2]

FrVect::demote_ret_type FrameCPP::Version_3::FrVect::demote ( INT_2U  Target, demote_arg_type  Obj, istream_type *  Stream  ) const

protectedvirtual

Down grade an object.

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

demote() [2/2]

virtual demote_ret_type FrameCPP::Version_3::FrVect::demote ( INT_2U  Target, demote_arg_type  Obj, istream_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, istream_type *  Stream  )

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream 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, istream_type *  Stream  )

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream 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_3::FrVect::expandToBuffer	(	boost::shared_array< CHAR_U > &	Dest,
		INT_8U &	DestNBytes
	)		const

Todo:

The use of BYTE_ORDER_HOST here is flawed. Need to capture the byte order information when the object is read from disk. When initialially created, it will be in BYTE_ORDER_HOST order.

expandToBuffer() [3/3]

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

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]

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

inline

GetCompress() [2/2]

compress_type FrameCPP::Version_3::FrVect::GetCompress

(

)

const

GetData() [1/4]

FrVect::data_type FrameCPP::Version_3::FrVect::GetData

(

bool

Decompress = true

)

const

GetData() [2/4]

data_type FrameCPP::Version_3::FrVect::GetData

(

bool

Decompress = true

)

const

GetData() [3/4]

FrVect::data_type FrameCPP::Version_3::FrVect::GetData

(

bool

Decompress = true

)

GetData() [4/4]

data_type FrameCPP::Version_3::FrVect::GetData

(

bool

Decompress = true

)

GetDataRaw() [1/4]

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

inline

GetDataRaw() [2/4]

data_type FrameCPP::Version_3::FrVect::GetDataRaw

(

)

const

GetDataRaw() [3/4]

FrVect::data_type FrameCPP::Version_3::FrVect::GetDataRaw ( )

inline

GetDataRaw() [4/4]

data_type FrameCPP::Version_3::FrVect::GetDataRaw

(

)

GetDataType() [1/14]

template<class T >

static INT_2U FrameCPP::Version_3::FrVect::GetDataType ( )

static

GetDataType() [2/14]

template<class T >

static INT_2U FrameCPP::Version_3::FrVect::GetDataType ( )

static

GetDataType() [3/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [4/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [5/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [6/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [7/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [8/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [9/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [10/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [11/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [12/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [13/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDataType() [14/14]

template<>

INT_2U FrameCPP::Version_3::FrVect::GetDataType

(

)

GetDescription() [1/2]

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

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.

GetDim() [1/4]

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

inline

Todo:

Throw exception if value out of range

Todo:

Throw exception if value out of range

GetDim() [2/4]

const Dimension& FrameCPP::Version_3::FrVect::GetDim

(

nDim_type

Offset

)

const

GetDim() [3/4]

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

inline

Todo:

Throw exception if value out of range

Todo:

Throw exception if value out of range

GetDim() [4/4]

Dimension& FrameCPP::Version_3::FrVect::GetDim

(

nDim_type

Offset

)

GetName() [1/2]

const std::string & FrameCPP::Version_3::FrVect::GetName

(

)

const

GetName() [2/2]

const std::string& FrameCPP::Version_3::FrVect::GetName

(

)

const

GetNBytes() [1/2]

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

inline

GetNBytes() [2/2]

nBytes_type FrameCPP::Version_3::FrVect::GetNBytes

(

)

const

GetNData() [1/2]

nData_type FrameCPP::Version_3::FrVect::GetNData

(

)

const

GetNData() [2/2]

FrVect::nData_type FrameCPP::Version_3::FrVect::GetNData

(

)

const

GetNDim() [1/2]

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

inline

GetNDim() [2/2]

nDim_type FrameCPP::Version_3::FrVect::GetNDim

(

)

const

GetType() [1/2]

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

inline

GetType() [2/2]

type_type FrameCPP::Version_3::FrVect::GetType

(

)

const

GetTypeSize() [1/4]

size_t FrameCPP::Version_3::FrVect::GetTypeSize

(

)

const

Get size of single data point of particular size.

Returns

Data size.

GetTypeSize() [2/4]

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

inline

Get size of single data point of particular size.

Returns

Data size.

GetTypeSize() [3/4]

size_t FrameCPP::Version_3::FrVect::GetTypeSize ( type_type  type )

static

GetTypeSize() [4/4]

static size_t FrameCPP::Version_3::FrVect::GetTypeSize ( type_type  type )

static

GetUnitY() [1/2]

const std::string FrameCPP::Version_3::FrVect::GetUnitY

(

)

const

GetUnitY() [2/2]

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

inline

Merge() [1/2]

FrVect & FrameCPP::Version_3::FrVect::Merge

(

const FrVect &

RHS

)

Merge with another FrVect.

Parameters

[in]

RHS

The other FrVect with which to merge.

Returns

Reference to this object.

Todo:

Need to implement Merge routine

Merge() [2/2]

FrVect& FrameCPP::Version_3::FrVect::Merge

(

const FrVect &

RHS

)

Merge with another FrVect.

Parameters

[in]

RHS

The other FrVect with which to merge.

Returns

Reference to this object.

ObjectStructName() [1/2]

virtual const char* FrameCPP::Version_3::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]

const char * FrameCPP::Version_3::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_3::FrVect::operator!=

(

const FrVect &

RHS

)

const

operator!=() [2/2]

bool FrameCPP::Version_3::FrVect::operator!=

(

const FrVect &

RHS

)

const

operator+=() [1/2]

FrVect& FrameCPP::Version_3::FrVect::operator+=

(

const FrVect &

RHS

)

Concatination operator.

operator+=() [2/2]

FrVect & FrameCPP::Version_3::FrVect::operator+=

(

const FrVect &

RHS

)

Concatination operator.

Todo:

Need to have a list of reasons

Todo:

Need to have a list of reasons

operator==() [1/4]

bool FrameCPP::Version_3::FrVect::operator==

(

const FrVect &

RHS

)

const

operator==() [2/4]

bool FrameCPP::Version_3::FrVect::operator==

(

const FrVect &

RHS

)

const

operator==() [3/4]

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

virtual

comparison operator

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

operator==() [4/4]

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

virtual

comparison operator

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

Promote() [1/2]

FrVect::promote_ret_type FrameCPP::Version_3::FrVect::Promote ( INT_2U  Source, promote_arg_type  Obj, istream_type *  Stream  )

inlinestatic

Promote() [2/2]

static promote_ret_type FrameCPP::Version_3::FrVect::Promote ( INT_2U  Source, promote_arg_type  Obj, istream_type *  Stream  )

static

promote() [1/2]

virtual promote_ret_type FrameCPP::Version_3::FrVect::promote ( INT_2U  Target, promote_arg_type  Obj, istream_type *  Stream  ) const

protectedvirtual

Upgrade an object.

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

promote() [2/2]

FrVect::promote_ret_type FrameCPP::Version_3::FrVect::promote ( INT_2U  Target, promote_arg_type  Obj, istream_type *  Stream  ) const

protectedvirtual

Upgrade an object.

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

PromoteObject() [1/5]

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]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns

A pointer to the objected derived by promoting Obj.

PromoteObject() [2/5]

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]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns

A pointer to the objected derived by promoting Obj.

PromoteObject() [3/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, istream_type *  Stream  )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating 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, istream_type *  Stream  )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating 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, IStream *  Stream  )

inherited

SetName() [1/2]

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

inline

Establish the channel name.

Assign a new value for the channel name.

Parameters

[in]

Name

The channel name

SetName() [2/2]

void FrameCPP::Version_3::FrVect::SetName

(

const std::string &

Name

)

Establish the channel name.

Parameters

[in]

Name

The channel name

SetNData() [1/2]

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

inline

SetNData() [2/2]

void FrameCPP::Version_3::FrVect::SetNData

(

INT_4U

NData

)

StructDescription() [1/2]

const Description * FrameCPP::Version_3::FrVect::StructDescription ( )

static

StructDescription() [2/2]

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

static

StructName() [1/2]

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

static

StructName() [2/2]

const char * FrameCPP::Version_3::FrVect::StructName ( )

inlinestatic

SubFrVect() [1/2]

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

SubFrVect() [2/2]

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

Uncompress() [1/2]

void FrameCPP::Version_3::FrVect::Uncompress

(

)

Expand compressed data.

In general, uncompressing follows three steps:

1. Gunzip the data.
2. Fix byte-ordering.
3. Integrate.

Depending upon the compression type and byte-ordering differences, not all of these steps are needed.

Uncompress() [2/2]

void FrameCPP::Version_3::FrVect::Uncompress

(

)

Expand compressed data.

VerifyObject() [1/2]

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

virtual

Verify the integrity of the object.

Parameters

Verifier	The handle to the Verify object used to store data that needs to be accumulated before being processed.
Stream	The 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_3::FrVect::VerifyObject ( Common::Verify &  Verifier, Common::IFrameStream &  Stream  ) const

virtual

Verify the integrity of the object.

Parameters

Verifier	The handle to the Verify object used to store data that needs to be accumulated before being processed.
Stream	The 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_3::FrVect::Write ( ostream_type &  Stream ) const

virtual

Write the structure to the stream.

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

Write() [2/2]

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

virtual

Write the structure 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]

Stream

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

Stream

The output stream to receive the next pointer.

Returns

The output stream.

Member Data Documentation

BYTE_SWAP

static const INT_2U FrameCPP::Version_3::FrVectCompressionScheme::BYTE_SWAP = 0x100

staticinherited

DEFAULT_GZIP_LEVEL

static const int FrameCPP::Version_3::FrVect::DEFAULT_GZIP_LEVEL

static

m_data

data_container_type FrameCPP::Version_3::FrVect::m_data

private

s_object_id

static const Common::FrameSpec::Info::frame_object_types FrameCPP::Version_3::FrVect::s_object_id = Common::FrameSpec::Info::FSI_FR_VECT

staticprivate

---

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

• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version3/FrVect.hh
• Version3/FrVect.cc