Class Index Cross Index Namespace Index

Class FrameCPP::Version_6::FrVect


Contained in: FrameCPP::Version_6
Derived from: FrameCPP::Version_6::FrBase
Derived by: none

#include "../../../../../lib/framecpp/src/Version6/FrVect.hh"


public function member index:

FrVect(); Default constructor
FrVect(const FrVect& vect); Copy Constructor.
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 = ""); Constructor.
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 = "", bool allocate = true, bool owns = true); Constructor.
FrVect(const std::string& name, INT_4U nDim = 1, const Dimension* dims = 0, const T* data = 0, const std::string& unitY = "");
FrVect(const std::string& name, INT_4U nDim = 1, const Dimension* dims = 0, T* data = 0, const std::string& unitY = "", bool allocate = true, bool owns = true);
FrVect(const std::string& name, INT_2U type, INT_4U nDim, const INT_4U* dims, const byte_order_type byte_order = BYTE_ORDER_HOST, const void* data = 0, const std::string& unitY = ""); Constructor.
FrVect(const std::string& name, INT_2U type, INT_4U nDim, const INT_4U* dims, const byte_order_type byte_order = BYTE_ORDER_HOST, void* data = 0, const std::string& unitY = "", bool allocate = true, bool owns = true); Constructor.
FrVect(const std::string& name, INT_4U nDim = 1, const INT_4U* dims = 0, const T* data = 0, const std::string& unitY = "");
FrVect(const std::string& name, INT_4U nDim = 1, const INT_4U* dims = 0, T* data = 0, const std::string& unitY = "", bool allocate = true, bool owns = true);
virtual ~FrVect();
INT_8U Bytes() const; Number of bytes needed to write this structure
void Compress(compression_scheme_type Scheme, int GZipLevel);
INT_2U GetCompress() const;
const CHAR_U* GetData(bool Decompress = true) const;
CHAR_U* GetData(bool Decompress = true);
static INT_2U GetDataType();
const Dimension& GetDim(INT_4U Offset) const;
Dimension& GetDim(INT_4U Offset);
INT_8U GetNBytes() const;
INT_8U GetNData() const;
inline INT_4U GetNDim() const;
const std::string& GetName() const;
INT_2U GetType() const;
size_t GetTypeSize() const;
static size_t GetTypeSize(INT_2U type);
const std::string GetUnitY() const;
FrVect& Merge(const FrVect& RHS); Merge with another FrAdcData
static FrVect* ReadDynamic(IFrameStream& Stream, const FrBase& Base); Read the structure from stream
void SetNData(INT_4U NData);
std::auto_ptr< FrVect > SubFrVect(INT_4U Start, INT_4U Stop) const;
void Uncompress();
virtual void Write(OFrameStream& Stream) const; Write the structure to the stream
virtual void WriteDescription(OFrameStream& Stream) const; Write the structure description to the stream
void expand();
inline INT_2U getCompress() const;
inline const CHAR_U* getData() const;
inline CHAR_U* getData();
static INT_2U getDataType();
inline const Dimension& getDimension(INT_4U Offset) const;
inline Dimension& getDimension(INT_4U Offset);
inline INT_8U getNBytes() const;
inline INT_8U getNData() const;
inline INT_4U getNDim() const;
inline const std::string& getName() const;
static const CHAR* getStaticName();
inline INT_2U getType() const;
inline static size_t getTypeSize(INT_2U type);
inline const std::string getUnitY() const;
bool operator !=(const FrVect& RHS) const;
FrVect& operator +=(const FrVect& RHS); Concatination operator
bool operator ==(const FrVect& RHS) const; Comparison operator
inline void setNData(INT_4U NData);
 

private function member index:

void copy_data(CHAR_U* Data, INT_8U size, bool allocate, bool own);
void read(IFrameStream& Stream);
 

Description:



Function Member Descriptions:


FrameCPP::Version_6::FrVect::FrVect - Default constructor


FrVect();



FrameCPP::Version_6::FrVect::FrVect - Copy Constructor.


FrVect(const FrVect& vect);

Parameters:
ParameterDescription
const Vect& vectCopied vector.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_6::FrVect::FrVect - Constructor.


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 = "");

Parameters:
ParameterDescription
const std::string& nameThe name of the data.
INT_2U typeThe data type.
INT_4U nDimThe number of dimensions.
const Dimension* dimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
const byte_order_type byte_orderByte order of the data. Default is BIGENDIAN.
const void* dataA pointer to the data. Default: 0
const std::string& unitYUnits for the data. Default: ""

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_6::FrVect::FrVect - Constructor.


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

Parameters:
ParameterDescription
const std::string& nameThe name of the data.
INT_2U typeThe data type.
INT_4U nDimThe number of dimensions.
const Dimension* dimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
const byte_order_type byte_orderByte order of the data. Default is BIGENDIAN.
const void* dataA pointer to the data. Default: 0
const std::string& unitYUnits for the data. Default: ""
bool allocateWhether to allocate data. Default: true.
bool ownsWhether to destruct data in the destructor. Default: true.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_6::FrVect::FrVect


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

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_6::FrVect::FrVect


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

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_6::FrVect::FrVect - Constructor.


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

Parameters:
ParameterDescription
const std::string& nameThe name of the data.
INT_2U typeThe data type.
INT_4U nDimThe number of dimensions.
const INT_4U* dimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
const byte_order_type byte_orderByte order of the data. Default is BIGENDIAN.
const void* dataA pointer to the data. Default: 0
const std::string& unitYUnits for the data. Default: ""

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_6::FrVect::FrVect - Constructor.


FrVect(const std::string& name, INT_2U type, INT_4U nDim, const INT_4U* dims, const byte_order_type byte_order = BYTE_ORDER_HOST, void* data = 0, const std::string& unitY = "", bool allocate = true, bool owns = true);

Parameters:
ParameterDescription
const std::string& nameThe name of the data.
INT_2U typeThe data type.
INT_4U nDimThe number of dimensions.
const INT_4U* dimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
const byte_order_type byte_orderByte order of the data. Default is BIGENDIAN.
const void* dataA pointer to the data. Default: 0
const std::string& unitYUnits for the data. Default: ""
bool allocateWhether to allocate data. Default: true.
bool ownsWhether to destruct data in the destructor. Default: true.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_6::FrVect::FrVect


FrVect(const std::string& name, INT_4U nDim = 1, const INT_4U* dims = 0, const T* data = 0, const std::string& unitY = "");

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_6::FrVect::FrVect


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

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_6::FrVect::~FrVect


virtual ~FrVect();



FrameCPP::Version_6::FrVect::Bytes - Number of bytes needed to write this structure


INT_8U Bytes() const;



FrameCPP::Version_6::FrVect::Compress


void Compress(compression_scheme_type Scheme, int GZipLevel);
Mutators




FrameCPP::Version_6::FrVect::GetCompress


INT_2U GetCompress() const;



FrameCPP::Version_6::FrVect::GetData


const CHAR_U* GetData(bool Decompress = true) const;



FrameCPP::Version_6::FrVect::GetData


CHAR_U* GetData(bool Decompress = true);



FrameCPP::Version_6::FrVect::GetDataType


static INT_2U GetDataType();



FrameCPP::Version_6::FrVect::GetDim


const Dimension& GetDim(INT_4U Offset) const;



FrameCPP::Version_6::FrVect::GetDim


Dimension& GetDim(INT_4U Offset);



FrameCPP::Version_6::FrVect::GetNBytes


INT_8U GetNBytes() const;



FrameCPP::Version_6::FrVect::GetNData


INT_8U GetNData() const;



FrameCPP::Version_6::FrVect::GetNDim


inline INT_4U GetNDim() const;



FrameCPP::Version_6::FrVect::GetName


const std::string& GetName() const;
Accessors




FrameCPP::Version_6::FrVect::GetType


INT_2U GetType() const;



FrameCPP::Version_6::FrVect::GetTypeSize


size_t GetTypeSize() const;



FrameCPP::Version_6::FrVect::GetTypeSize


static size_t GetTypeSize(INT_2U type);



FrameCPP::Version_6::FrVect::GetUnitY


const std::string GetUnitY() const;



FrameCPP::Version_6::FrVect::Merge - Merge with another FrAdcData


FrVect& Merge(const FrVect& RHS);



FrameCPP::Version_6::FrVect::ReadDynamic - Read the structure from stream


static FrVect* ReadDynamic(IFrameStream& Stream, const FrBase& Base);



FrameCPP::Version_6::FrVect::SetNData


void SetNData(INT_4U NData);



FrameCPP::Version_6::FrVect::SubFrVect


std::auto_ptr< FrVect > SubFrVect(INT_4U Start, INT_4U Stop) const;



FrameCPP::Version_6::FrVect::Uncompress


void Uncompress();



FrameCPP::Version_6::FrVect::Write - Write the structure to the stream


virtual void Write(OFrameStream& Stream) const;



FrameCPP::Version_6::FrVect::WriteDescription - Write the structure description to the stream


virtual void WriteDescription(OFrameStream& Stream) const;



FrameCPP::Version_6::FrVect::copy_data


void copy_data(CHAR_U* Data, INT_8U size, bool allocate, bool own);



FrameCPP::Version_6::FrVect::expand


void expand();



FrameCPP::Version_6::FrVect::getCompress


inline INT_2U getCompress() const;



FrameCPP::Version_6::FrVect::getData


inline const CHAR_U* getData() const;



FrameCPP::Version_6::FrVect::getData


inline CHAR_U* getData();



FrameCPP::Version_6::FrVect::getDataType


static INT_2U getDataType();



FrameCPP::Version_6::FrVect::getDimension


inline const Dimension& getDimension(INT_4U Offset) const;



FrameCPP::Version_6::FrVect::getDimension


inline Dimension& getDimension(INT_4U Offset);



FrameCPP::Version_6::FrVect::getNBytes


inline INT_8U getNBytes() const;



FrameCPP::Version_6::FrVect::getNData


inline INT_8U getNData() const;



FrameCPP::Version_6::FrVect::getNDim


inline INT_4U getNDim() const;



FrameCPP::Version_6::FrVect::getName


inline const std::string& getName() const;



FrameCPP::Version_6::FrVect::getStaticName


static const CHAR* getStaticName();



FrameCPP::Version_6::FrVect::getType


inline INT_2U getType() const;



FrameCPP::Version_6::FrVect::getTypeSize


inline static size_t getTypeSize(INT_2U type);



FrameCPP::Version_6::FrVect::getUnitY


inline const std::string getUnitY() const;



FrameCPP::Version_6::FrVect::operator !=


bool operator !=(const FrVect& RHS) const;



FrameCPP::Version_6::FrVect::operator += - Concatination operator


FrVect& operator +=(const FrVect& RHS);



FrameCPP::Version_6::FrVect::operator == - Comparison operator


bool operator ==(const FrVect& RHS) const;



FrameCPP::Version_6::FrVect::read


void read(IFrameStream& Stream);



FrameCPP::Version_6::FrVect::setNData


inline void setNData(INT_4U NData);



Variable Member Descriptions:


FrameCPP::Version_6::FrVect::DEFAULT_GZIP_LEVEL -

static const int DEFAULT_GZIP_LEVEL;

FrameCPP::Version_6::FrVect::HOST_ORDER -

static const ByteOrder HOST_ORDER;

FrameCPP::Version_6::FrVect::m_data -

data_definition_type m_data;

FrameCPP::Version_6::FrVect::m_owns -

bool m_owns;