ldas-tools-framecpp
2.6.5
|
Vector Data Structure Definition. More...
#include <FrVect.hh>
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, compress_type Compress, type_type type, nDim_type nDim, const Dimension *dims, nData_type NData, nBytes_type NBytes, data_type Data, const std::string &unitY="") | |
FrVect (const std::string &Name, type_type Type, nDim_type NDim, const Dimension *Dims, 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="") | |
template<class T > | |
FrVect (const std::string &name, nDim_type nDim=1, const Dimension *dims=0, T *data=0, const std::string &unitY="") | |
FrVect (const Previous::FrVect &Source, Common::IStream *Stream) | |
Promotion Constructor. More... | |
virtual | ~FrVect () |
Destructor. More... | |
void | MimeData (const std::string &MimeType, void *Data, nBytes_type DataSize) |
Set the current FrVect with the MIME data. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
bool | operator== (const FrVect &RHS) const |
equality operator More... | |
bool | operator!= (const FrVect &RHS) const |
inequality operator More... | |
FrVect & | operator+= (const FrVect &RHS) |
Concatinate with another FrAdcData. More... | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator More... | |
const std::string & | GetName () const |
Retrieve the channel name. More... | |
compress_type | GetCompress () const |
Retrieve the compression algorithm number. More... | |
type_type | GetType () const |
Retrieve the vector class. More... | |
nData_type | GetNData () const |
Retrieve the number of sample elements in data series. More... | |
nBytes_type | GetNBytes () const |
Retrieve the number of bytes in the compressed vector. More... | |
data_type | GetData () const |
Retrieve the pointer to the data. More... | |
data_type | GetDataRaw () const |
Retrieve the pointer to the compressed data. More... | |
data_type | GetDataRaw () |
Retrieve the pointer to the compressed data. More... | |
data_type | GetDataUncompressed () |
Retrieve the pointer to the uncompressed data. More... | |
const CHAR_U * | GetDataUncompressed (data_type &Expanded) const |
Retrieve the pointer to the uncompressed data. More... | |
nDim_type | GetNDim () const |
Retrieve the number of dimensions. More... | |
const Dimension & | GetDim (nDim_type Offset) const |
Retrieve the Nth dimension. More... | |
Dimension & | GetDim (nDim_type Offset) |
Retrieve the Nth dimension. More... | |
dimension_container_type & | GetDims () |
Retrieve all the dimension information. More... | |
const std::string & | GetUnitY () const |
Retrieve the description of how to interpret each element. More... | |
void | Compress (compression_scheme_type Scheme, int GZipLevel) |
void | Uncompress () |
virtual void | CompressData (INT_4U Scheme, INT_2U GZipLevel) |
virtual Compression::compression_base_type | Compression () const |
virtual Common::FrameSpec::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 | SetUnitY (const std::string &UnitY) |
Set the description of how to interpret each element. More... | |
void | SetNData (nData_type NData) |
size_t | GetTypeSize () const |
FrVect & | Merge (const FrVect &RHS) |
Merge with another FrAdcData. More... | |
subfrvect_type | SubFrVect (INT_4U Start, INT_4U Stop) const |
Request a subset of the data. More... | |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
template<> | |
FrVect::type_type | GetDataType () |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
class_type | GetClass () const |
Retrieve the class identifier. 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... | |
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, Common::IStream *Stream) |
Promote previous version of object to this version. More... | |
static const char * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static data_type | DataAlloc (type_type Type, const Dimension *Dims, const nDim_type NDim=1) |
Allocate a block of memory suitable for storing data. More... | |
template<class T > | |
static type_type | GetDataType () |
static size_t | GetTypeSize (type_type Type) |
Get size of single data point of particular size. More... | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. More... | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. More... | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. More... | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
template<typename PreviousType , typename CurrentType > | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
Static Public Attributes | |
static const int | DEFAULT_GZIP_LEVEL |
Protected Member Functions | |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Verify the integrity of the object. More... | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const |
Demotes object to previous version of the frame spec. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const |
Promotes object to another version of the frame spec. More... | |
virtual FrameCPP::cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrVect * | pCreate (Common::IStream &Stream) const |
Stream constructor. More... | |
virtual void | pWrite (Common::OStream &Stream) const |
Write the structure to the stream. More... | |
void | expandToBuffer (data_type &Dest, nBytes_type &DestNBytes) const |
virtual class_type | getClass () const |
Retrieve the class identifier. More... | |
void | compressToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::compress_type_reverse_mapping &CompressionReverseMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, Compression::output_type &Dest, INT_8U &DestNBytes, INT_4U &DestCompressionMode, const INT_4U Level) const |
void | expandToBuffer (const Compression::compress_type_mapping &CompressionMapping, const Compression::data_type_mapping &DataTypeMapping, const INT_4U DataType, const INT_8U NData, const CHAR_U *Source, const INT_8U SourceNBytes, const INT_4U SourceCompressionMode, const INT_4U SourceByteOrder, Compression::output_type &Dest, INT_8U &DestNBytes) const |
Vector Data Structure Definition.
|
inherited |
|
inherited |
typedef data_type::element_type FrameCPP::Version_8::FrVect::data_element_type |
typedef boost::shared_array< CHAR_U > FrameCPP::Version_8::FrVect::data_type |
|
inherited |
|
inherited |
typedef std::vector< Dimension > FrameCPP::Version_8::FrVect::dimension_container_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef std::unique_ptr< FrVect > FrameCPP::Version_8::FrVect::subfrvect_type |
|
inherited |
FrVect::FrVect | ( | ) |
Default constructor.
FrVect::FrVect | ( | const FrVect & | vect | ) |
Copy Constructor.
[in] | vect | The object from which to copy the information. |
FrameCPP::Version_8::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.
[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 BYTE_ORDER_HOST |
[in] | data | A pointer to the data. Default: 0 |
[in] | unitY | Units for the data. Default: "" |
FrameCPP::Version_8::FrVect::FrVect | ( | const std::string & | name, |
compress_type | Compress, | ||
type_type | type, | ||
nDim_type | nDim, | ||
const Dimension * | dims, | ||
nData_type | NData, | ||
nBytes_type | NBytes, | ||
data_type | Data, | ||
const std::string & | unitY = "" |
||
) |
FrVect::FrVect | ( | const std::string & | Name, |
type_type | Type, | ||
nDim_type | NDim, | ||
const Dimension * | Dims, | ||
const std::string & | UnitY | ||
) |
Constructor.
[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] | UnitY | Units for the data. |
FrameCPP::Version_8::FrVect::FrVect | ( | const std::string & | name, |
nDim_type | nDim = 1 , |
||
const Dimension * | dims = 0 , |
||
const T * | data = 0 , |
||
const std::string & | unitY = "" |
||
) |
FrameCPP::Version_8::FrVect::FrVect | ( | const std::string & | name, |
nDim_type | nDim = 1 , |
||
const Dimension * | dims = 0 , |
||
T * | data = 0 , |
||
const std::string & | unitY = "" |
||
) |
FrVect::FrVect | ( | const Previous::FrVect & | Source, |
Common::IStream * | Stream | ||
) |
|
virtual |
Destructor.
Reimplemented from FrameCPP::Common::FrVect.
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHeader.
|
virtual |
Implements FrameCPP::Common::FrVect.
void FrVect::Compress | ( | compression_scheme_type | Scheme, |
int | GZipLevel | ||
) |
|
virtual |
Implements FrameCPP::Common::FrVect.
|
inlinevirtual |
Implements FrameCPP::Common::FrVect.
|
protectedinherited |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
static |
Allocate a block of memory suitable for storing data.
[in] | Type | The type of data that is to be stored in the buffer. |
[in] | Dims | Information concearning each dimension of the array of data to be stored in the buffer. |
[in] | NDim | The number of dimensions of data to be stored in the buffer |
|
protectedvirtual |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Down grade an object.
[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. |
|
protectedinherited |
|
protected |
|
inlineinherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
Retrieve the compression algorithm number.
|
inline |
Retrieve the pointer to the data.
Return a pointer to the data being managed by the FrVect structure.
FrVect::data_type FrVect::GetDataRaw | ( | ) | const |
Retrieve the pointer to the compressed data.
FrVect::data_type FrVect::GetDataRaw | ( | ) |
Retrieve the pointer to the compressed data.
|
static |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::type_type FrameCPP::Version_8::FrVect::GetDataType | ( | ) |
FrVect::data_type FrVect::GetDataUncompressed | ( | ) |
Retrieve the pointer to the uncompressed data.
FrVect::data_const_pointer_type FrVect::GetDataUncompressed | ( | data_type & | Expanded | ) | const |
Retrieve the pointer to the uncompressed data.
[in] | Expanded | Buffer into which the data is expanded. |
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
Retrieve the Nth dimension.
[in] | Offset | Index for desired dimension |
Retrieve the Nth dimension.
[in] | Offset | Index for desired dimension |
|
inline |
Retrieve all the dimension information.
const std::string & FrVect::GetName | ( | ) | const |
Retrieve the channel name.
|
inline |
Retrieve the number of bytes in the compressed vector.
|
inline |
Retrieve the number of sample elements in data series.
|
inline |
Retrieve the number of dimensions.
|
inline |
Retrieve the vector class.
|
inline |
|
static |
Get size of single data point of particular size.
[in] | Type | Data type ID. |
|
inline |
Retrieve the description of how to interpret each element.
void FrVect::MimeData | ( | const std::string & | MimeType, |
void * | Data, | ||
nBytes_type | DataSize | ||
) |
Set the current FrVect with the MIME data.
|
virtual |
The name structure name of this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
bool FrVect::operator!= | ( | const FrVect & | RHS | ) | const |
inequality operator
[in] | RHS | The FrAdcData object to be compared. |
bool FrVect::operator== | ( | const FrVect & | RHS | ) | const |
equality operator
[in] | RHS | The FrAdcData object to be compared. |
|
virtual |
equality operator
[in] | RHS | The FrVect object to be compared. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
protectedvirtual |
Stream constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
inlinestatic |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
protectedvirtual |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Upgrade an object.
[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. |
|
staticinherited |
Upgrade an object.
[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. |
|
inherited |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
inline |
Establish the channel name.
Assign a new value for the channel name.
[in] | Name | The channel name |
|
inline |
|
inline |
Set the description of how to interpret each element.
Assign a new value for the channel name.
[in] | UnitY | New description |
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
FrVect::subfrvect_type FrVect::SubFrVect | ( | INT_4U | Start, |
INT_4U | Stop | ||
) | const |
Request a subset of the data.
[in] | Start | The offset in the data set where to start. |
[in] | Stop | The offset in the data set where to stop. |
void FrVect::Uncompress | ( | ) |
|
protectedvirtual |
Verify the integrity of the object.
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. |
This routine is called to verify the integrety of this FrVect object.
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
Write object to the stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
static |