Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::Vect

This class represents vector data.
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::Base
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/vect.hh"


public function member index:

Vect(); Default Constructor.
Vect(const Vect& vect); Copy Constructor.
Vect(const std::string& name, INT_2U type, INT_4U nDim, const Dimension* dims, const ByteOrder byte_order = BIG, const void* data = 0, const std::string& unitY = ""); Constructor.
Vect(const std::string& name, INT_2U type, INT_4U nDim, const Dimension* dims, const ByteOrder byte_order = BIG, void* data = 0, const std::string& unitY = "", bool allocate = true, bool owns = true); Constructor.
Vect(const std::string& name, INT_2U type, INT_4U nDim, const INT_4U* dims, const ByteOrder byte_order = BIG, const void* data = 0, const std::string& unitY = ""); Constructor.
Vect(const std::string& name, INT_2U type, INT_4U nDim, const INT_4U* dims, const ByteOrder byte_order = BIG, void* data = 0, const std::string& unitY = "", bool allocate = true, bool owns = true); Constructor.
Vect(const std::string& name, INT_4U nDim = 1, const Dimension* dims = 0, const T* data = 0, const std::string& unitY = ""); Constructor.
Vect(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); Constructor.
Vect(const std::string& name, INT_4U nDim = 1, const INT_4U* dims = 0, const T* data = 0, const std::string& unitY = ""); Constructor.
Vect(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); Constructor.
virtual ~Vect(); Destructor.
void byteSwapData(); Perform byte swapping operation on vector data
void compress(Compression c, size_t level = 6); Compress the data for this Vect.
void expand(); Expand compressed data.
inline ByteOrder getByteOrder() const; Get the byte ordering of the data.
virtual INT_2U getClassId() const;
inline Compression getCompress() const; Get the compression algorithm.
inline void* getData(bool decompress = true); Get a pointer to the data.
inline const void* getData(bool decompress = true) const; Get a pointer to the data.
inline Dimension& getDimension(size_t index); Get dimension information.
inline const Dimension& getDimension(size_t index) const; Get dimension information.
inline INT_4U getNBytes() const; Get the number of bytes in the compressed vector.
inline INT_4U getNData() const; Get the number of sampled elements in the data series.
inline INT_4U getNDim() const; Get the dimensionality of the data vector.
const std::string& getName() const;
static SH getSH(); Constructs the Structure Header for this class.
static SH getSH3(); Constructs frame data format version 3 Structure Header for this class.
static SH getSH4(); Constructs frame data format version 4 Structure Header for this class.
inline INT_2U getType() const; Get the vector data type.
static size_t getTypeSize(INT_2U type); Get size of single data point of particular size.
inline const std::string& getUnitY() const; Get the std::string describing how to interpret the value of each element.
inline bool isDataOwned() const; See if data is owned by this vector
inline bool operator !=(const Vect& vect) const; Not-equal comparison.
const Vect& operator +=(const Vect& vect); += Assignment Operator.
const Vect& operator =(const Vect& vect); Assignment Operator.
bool operator ==(const Vect& vect) const; Equal comparison operator.
void setData(const void* data); Set the data.
void setData(void* data, bool allocate = true, bool owns = true); Set or adopt the data.
inline void setDataNeedsByteSwap(bool swap); Set byteswap required flag.
inline void setDataOwnership(bool owns); Set data ownership flag.
void setDimension(std::vector<Dimension>& dims); Set the dimensions.
void setNBytes(INT_4U nb); Set the number of data bytes.
void setNData(INT_4U nd); Set the number of data points.
 

private function member index:

Vect(const std::string& name, INT_4U nDim, const Dimension* dims, const COMPLEX_8* data, const std::string& unitY);
Vect(const std::string& name, INT_4U nDim, const Dimension* dims, const COMPLEX_16*, const std::string& unitY);
Vect(const std::string& name, INT_4U nDim, const Dimension* dims, COMPLEX_8* data, const std::string& unitY, bool allocate, bool owns);
Vect(const std::string& name, INT_4U nDim, const Dimension* dims, COMPLEX_16* data, const std::string& unitY, bool allocate, bool owns);
Vect(const std::string& name, INT_4U nDim, const INT_4U* dims, const COMPLEX_8* data, const std::string& unitY);
Vect(const std::string& name, INT_4U nDim, const INT_4U* dims, const COMPLEX_16* data, const std::string& unitY);
Vect(const std::string& name, INT_4U nDim, const INT_4U* dims, COMPLEX_8* data, const std::string& unitY, bool allocate, bool owns);
Vect(const std::string& name, INT_4U nDim, const INT_4U* dims, COMPLEX_16* data, const std::string& unitY, bool allocate, bool owns);
static int FrVectZComp(unsigned short* out, unsigned long* compL, short* data, int nData, int bSize); Suppress zeroes.
static void FrVectZExpand(short* out, unsigned short* data, int nData); Expand zero suppressed data.
void deleteData(); Delete owned data.
void diffCompress(); Differentially compress the data.
void diffCompressType(); Differentially compress the data.
static Type getDataType(); Template function to get the type ID corresponding to certain data type.
void gzipCompress(size_t level); Compress the data with GZip.
static Vect* read(FrameReaderBase& in); Reads an Vect object from an FrameReaderBase object.
static Vect* read3(FrameReaderBase& in); Read legacy data vector.
static Vect* read4(FrameReaderBase& in); Read legacy data vector.
virtual void write(Output& out) const; Writes a Vect object to an Output object.
void zCompress(); Suppress zeroes.
 

Description:

It is modeled after the FrVect structure in the Frame Specification, LIGO-T970130-B-E.


Function Member Descriptions:


FrameCPP::Version_3_4_5::Vect::Vect - Default Constructor.


Vect();
This creates a Vect object with the following properties:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Vect::Vect - Copy Constructor.


Vect(const Vect& vect);

Parameters:
ParameterDescription
const Vect& vectCopied vector.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::Vect - Constructor.


Vect(const std::string& name, INT_2U type, INT_4U nDim, const Dimension* dims, const ByteOrder byte_order = BIG, 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 ByteOrder 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_3_4_5::Vect::Vect - Constructor.


Vect(const std::string& name, INT_2U type, INT_4U nDim, const Dimension* dims, const ByteOrder byte_order = BIG, 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 ByteOrder 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_3_4_5::Vect::Vect - Constructor.


Vect(const std::string& name, INT_2U type, INT_4U nDim, const INT_4U* dims, const ByteOrder byte_order = BIG, 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 ByteOrder 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_3_4_5::Vect::Vect - Constructor.


Vect(const std::string& name, INT_2U type, INT_4U nDim, const INT_4U* dims, const ByteOrder byte_order = BIG, 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 ByteOrder 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_3_4_5::Vect::Vect - Constructor.


Vect(const std::string& name, INT_4U nDim = 1, const Dimension* dims = 0, const T* data = 0, const std::string& unitY = "");
This creates a Vect object from a pointer to data.

Parameters:
ParameterDescription
const std::string& nameThe name for the data.
INT_4U nDimThe number of dimensions.
const Dimension* dimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
const T* dataA pointer to the data. This will be copied into the Vector.
const std::string& unitYUnits for the data.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::Vect - Constructor.


Vect(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);
This creates a Vect object from a pointer to data.

Parameters:
ParameterDescription
const std::string& nameThe name for the data.
INT_4U nDimThe number of dimensions.
const Dimension* dimsA pointer to 'nDim' Dimension objects containing information about the dimensions for this data.
const T* dataA pointer to the data. This will be copied into the Vector.
const std::string& unitYUnits for the data.
bool allocateWhether to allocate data. Default: true.
bool ownsWhether to destruct data in the destructor. Default: true.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::Vect - Constructor.


Vect(const std::string& name, INT_4U nDim = 1, const INT_4U* dims = 0, const T* data = 0, const std::string& unitY = "");
This creates a Vect object from a pointer to data.

Parameters:
ParameterDescription
const std::string& nameThe name for the data.
INT_4U nDimThe number of dimensions.
const INT_4U* dimsA pointer to 'nDim' integers containing the sizes for each dimension.
const T* dataA pointer to the data. This will be copied into the Vector.
const std::string& unitYUnits for the data.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::Vect - Constructor.


Vect(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);
This creates a Vect object from a pointer to data.

Parameters:
ParameterDescription
const std::string& nameThe name for the data.
INT_4U nDimThe number of dimensions.
const INT_4U* dimsA pointer to 'nDim' size_tegers containing the sizes for each dimension.
const T* dataA pointer to the data. This will be copied into the Vector.
const std::string& unitYUnits for the data.
bool allocateWhether to allocate data. Default: true.
bool ownsWhether to destruct data in the destructor. Default: true.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::Vect


Vect(const std::string& name, INT_4U nDim, const Dimension* dims, const COMPLEX_8* data, const std::string& unitY);

Exceptions:
ExceptionDescription
std::bad_alloc



FrameCPP::Version_3_4_5::Vect::Vect


Vect(const std::string& name, INT_4U nDim, const Dimension* dims, const COMPLEX_16*, const std::string& unitY);

Exceptions:
ExceptionDescription
std::bad_alloc



FrameCPP::Version_3_4_5::Vect::Vect


Vect(const std::string& name, INT_4U nDim, const Dimension* dims, COMPLEX_8* data, const std::string& unitY, bool allocate, bool owns);

Exceptions:
ExceptionDescription
std::bad_alloc



FrameCPP::Version_3_4_5::Vect::Vect


Vect(const std::string& name, INT_4U nDim, const Dimension* dims, COMPLEX_16* data, const std::string& unitY, bool allocate, bool owns);

Exceptions:
ExceptionDescription
std::bad_alloc



FrameCPP::Version_3_4_5::Vect::Vect


Vect(const std::string& name, INT_4U nDim, const INT_4U* dims, const COMPLEX_8* data, const std::string& unitY);

Exceptions:
ExceptionDescription
std::bad_alloc



FrameCPP::Version_3_4_5::Vect::Vect


Vect(const std::string& name, INT_4U nDim, const INT_4U* dims, const COMPLEX_16* data, const std::string& unitY);

Exceptions:
ExceptionDescription
std::bad_alloc



FrameCPP::Version_3_4_5::Vect::Vect


Vect(const std::string& name, INT_4U nDim, const INT_4U* dims, COMPLEX_8* data, const std::string& unitY, bool allocate, bool owns);

Exceptions:
ExceptionDescription
std::bad_alloc



FrameCPP::Version_3_4_5::Vect::Vect


Vect(const std::string& name, INT_4U nDim, const INT_4U* dims, COMPLEX_16* data, const std::string& unitY, bool allocate, bool owns);

Exceptions:
ExceptionDescription
std::bad_alloc



FrameCPP::Version_3_4_5::Vect::~Vect - Destructor.


virtual ~Vect();
Deletes data, if it is owned.

Exceptions:
ExceptionDescription
None



FrameCPP::Version_3_4_5::Vect::FrVectZComp - Suppress zeroes.


static int FrVectZComp(unsigned short* out, unsigned long* compL, short* data, int nData, int bSize);
Borrowed from FrameL.c, v3r85




FrameCPP::Version_3_4_5::Vect::FrVectZExpand - Expand zero suppressed data.


static void FrVectZExpand(short* out, unsigned short* data, int nData);
Borrowed from FrameL.c, v3r85




FrameCPP::Version_3_4_5::Vect::byteSwapData - Perform byte swapping operation on vector data


void byteSwapData();



FrameCPP::Version_3_4_5::Vect::compress - Compress the data for this Vect.


void compress(Compression c, size_t level = 6);

Parameters:
ParameterDescription
Compression cCompressions type.
size_t levelCompressions level.



FrameCPP::Version_3_4_5::Vect::deleteData - Delete owned data.


void deleteData();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Vect::diffCompress - Differentially compress the data.


void diffCompress();
The data must be in an uncompressed state before this is called.




FrameCPP::Version_3_4_5::Vect::diffCompressType - Differentially compress the data.


void diffCompressType();
The data must be in an uncompressed state before this is called.




FrameCPP::Version_3_4_5::Vect::expand - Expand compressed data.


void expand();
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.




FrameCPP::Version_3_4_5::Vect::getByteOrder - Get the byte ordering of the data.


inline ByteOrder getByteOrder() const;

Return value:
ByteOrder- Endianness of vector's data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Vect::getCompress - Get the compression algorithm.


inline Compression getCompress() const;

Return value:
INT_2U- Compression algorithm ID.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::getData - Get a pointer to the data.


inline void* getData(bool decompress = true);

Parameters:
ParameterDescription
bool decompressWhether to expand compressed data.

Return value:
void*- Vector data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::getData - Get a pointer to the data.


inline const void* getData(bool decompress = true) const;

Parameters:
ParameterDescription
bool decompressWhether to expand compressed data.

Return value:
const void*- Vector data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::getDataType - Template function to get the type ID corresponding to certain data type.


static Type getDataType();
Template specifications

Return value:
Type


FrameCPP::Version_3_4_5::Vect::getDimension - Get dimension information.


inline Dimension& getDimension(size_t index);

Parameters:
ParameterDescription
size_t indexWhich dimension.

Return value:
Dimension&- Reuqested dimension's info.

Exceptions:
ExceptionDescription
std::range_error
std::range_errorBad dimensions index given.



FrameCPP::Version_3_4_5::Vect::getDimension - Get dimension information.


inline const Dimension& getDimension(size_t index) const;

Parameters:
ParameterDescription
size_t indexWhich dimension.

Return value:
const Dimension&- Reuqested dimension's info.

Exceptions:
ExceptionDescription
std::range_error
std::range_errorBad dimensions index given.



FrameCPP::Version_3_4_5::Vect::getNBytes - Get the number of bytes in the compressed vector.


inline INT_4U getNBytes() const;

Return value:
INT_4U- (Compressed) Data size.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::getNData - Get the number of sampled elements in the data series.


inline INT_4U getNData() const;

Return value:
INT_4U- Number of data points.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::getNDim - Get the dimensionality of the data vector.


inline INT_4U getNDim() const;

Return value:
mNDim- Number of data dimensions.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::getName


const std::string& getName() const;



FrameCPP::Version_3_4_5::Vect::getSH - Constructs the Structure Header for this class.


static SH getSH();

Return value:
SH- Vector class structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::getSH3 - Constructs frame data format version 3 Structure Header for this class.


static SH getSH3();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::getSH4 - Constructs frame data format version 4 Structure Header for this class.


static SH getSH4();

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::getType - Get the vector data type.


inline INT_2U getType() const;

Return value:
INT_2U- Vector data type ID.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::getTypeSize - Get size of single data point of particular size.


static size_t getTypeSize(INT_2U type);

Parameters:
ParameterDescription
INT_2U typeData type ID.

Return value:
INT_2U- Data size.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Vect::getUnitY - Get the std::string describing how to interpret the value of each element.


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

Return value:
const std::string&- Data units.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::gzipCompress - Compress the data with GZip.


void gzipCompress(size_t level);
The data must be in an uncompressed state before this is called.

Parameters:
ParameterDescription
size_t levelCompression level.



FrameCPP::Version_3_4_5::Vect::isDataOwned - See if data is owned by this vector


inline bool isDataOwned() const;

Return value:
bool- Data is owned or not.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::operator != - Not-equal comparison.


inline bool operator !=(const Vect& vect) const;

Parameters:
ParameterDescription
const Vect& vectThe object to compare with.

Return value:
bool- True if the objects are not equal.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::operator += - += Assignment Operator.


const Vect& operator +=(const Vect& vect);

Parameters:
ParameterDescription
const Vect& vectVector with which to concatenate.

Return value:
const Vect&- This vector.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
frame_mismatchVectors are incompatible.



FrameCPP::Version_3_4_5::Vect::operator = - Assignment Operator.


const Vect& operator =(const Vect& vect);

Parameters:
ParameterDescription
const Vect& vectVector to be assigned.

Return value:
const Vect&- This vector.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::operator == - Equal comparison operator.


bool operator ==(const Vect& vect) const;
Determines whether two Vect objects are equal. For this comparison, all of the data is compared.

Parameters:
ParameterDescription
const Vect& vThe object with which to compare.

Return value:
bool- True if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Vect::read - Reads an Vect object from an FrameReaderBase object.


static Vect* read(FrameReaderBase& in);
This method creates a dynamically allocated object.

*NOTE* This method allocates memory and returns a pointer to it. The user is responsible for freeing this memory.


Parameters:
ParameterDescription
FrameReaderBase& inData source.

Return value:
Vect*- Newly created vector.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureData read failure occured.



FrameCPP::Version_3_4_5::Vect::read3 - Read legacy data vector.


static Vect* read3(FrameReaderBase& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureData read failure occured.



FrameCPP::Version_3_4_5::Vect::read4 - Read legacy data vector.


static Vect* read4(FrameReaderBase& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureData read failure occured.



FrameCPP::Version_3_4_5::Vect::setData - Set the data.


void setData(const void* data);

Parameters:
ParameterDescription
const void* dataData to be copied to the vector.

Exceptions:
ExceptionDescription
bad allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::setData - Set or adopt the data.


void setData(void* data, bool allocate = true, bool owns = true);

Parameters:
ParameterDescription
const void* dataData to be copied to the vect.
bool allocateWhether to allocate data. Default: true.
bool ownsWhether to destruct data in the destructor. Default: true.

Exceptions:
ExceptionDescription
bad allocMemory allocation failed.



FrameCPP::Version_3_4_5::Vect::setDataNeedsByteSwap - Set byteswap required flag.


inline void setDataNeedsByteSwap(bool swap);

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::setDataOwnership - Set data ownership flag.


inline void setDataOwnership(bool owns);

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Vect::setDimension - Set the dimensions.


void setDimension(std::vector<Dimension>& dims);

Parameters:
ParameterDescription
std::vector& dimsNew dimensions.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Vect::setNBytes - Set the number of data bytes.


void setNBytes(INT_4U nb);

Parameters:
ParameterDescription
INT_4U nbNew number of data bytes.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Vect::setNData - Set the number of data points.


void setNData(INT_4U nd);

Parameters:
ParameterDescription
INT_4U ndNew number of data points.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Vect::write - Writes a Vect object to an Output object.


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& out outOutput data stream.

Exceptions:
ExceptionDescription
write_failureData write failure occured.



FrameCPP::Version_3_4_5::Vect::zCompress - Suppress zeroes.


void zCompress();



Variable Member Descriptions:


FrameCPP::Version_3_4_5::Vect::bzip2_blockSize100k - BZIP2 compression parameter blockSize100k specifies the block size to be used for compression.

static const int bzip2_blockSize100k;
It should be a value between 1 and 9 inclusive, and the actual block size used is 100000 x this figure. 9 gives the best compression but takes most memory.


FrameCPP::Version_3_4_5::Vect::bzip2_workFactor - BZIP2 compression parameter workFactor controls how the compression phase behaves when presented with worst case, highly repetitive, input data.

static const int bzip2_workFactor;
If compression runs into difficulties caused by repetitive data, the library switches from the standard sorting algorithm to a fallback algorithm. The fallback is slower than the standard algorithm by perhaps a factor of three, but always behaves reasonably, no matter how bad the input. The default value of 30 gives reasonable behaviour over a wide range of circumstances.


FrameCPP::Version_3_4_5::Vect::dataNeedsByteSwap - Whether data needs to be byte swapped before use.

bool dataNeedsByteSwap;

FrameCPP::Version_3_4_5::Vect::mCompress - Compression algorithm number.

INT_2U mCompress;

FrameCPP::Version_3_4_5::Vect::mData - Data.

unsigned char* mData;

FrameCPP::Version_3_4_5::Vect::mDimension - Dimension info.

std::vector< Dimension > mDimension;

FrameCPP::Version_3_4_5::Vect::mNBytes - Number of bytes in the compressed vector.

INT_4U mNBytes;

FrameCPP::Version_3_4_5::Vect::mNData - Number of sample elements in data series.

INT_4U mNData;

FrameCPP::Version_3_4_5::Vect::mNDim - Dimensionality of data vector.

INT_4U mNDim;

FrameCPP::Version_3_4_5::Vect::mName - Vector name.

std::string mName;

FrameCPP::Version_3_4_5::Vect::mOwnsData - Whether this vector owns its data.

bool mOwnsData;

FrameCPP::Version_3_4_5::Vect::mType - Vector class.

INT_2U mType;

FrameCPP::Version_3_4_5::Vect::mUnitY - How to interpret value of each element.

std::string mUnitY;