A generic interface for a data frame consisting of contiguous blocks of arbitrary-sized types. More...

#include <carma/szautil/DataFrame.h>

Inherited by sza::util::DataFrameNormal.

Public Member Functions
void	addRunningAverage (void *data, AxisRange &range, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack an array into our internal memory. More...

void	addRunningAverage (void *data, unsigned ndata, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack an array into our internal memory from consecutive locations in the input data array. More...

void	addSum (void *data, AxisRange &range, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack an array into our internal memory. More...

void	addSum (void *data, unsigned ndata, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack an array into our internal memory from consecutive locations in the input data array. More...

void	addUnion (void *data, AxisRange &range, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack an array into our internal memory. More...

void	addUnion (void *data, unsigned ndata, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack an array into our internal memory from consecutive locations in the input data array. More...

virtual unsigned char *	data ()=0
	Get a pointer to our internal data suitable for using as an external network buffer. More...

	DataFrame ()
	Constructors. More...

virtual std::vector< unsigned char > &	dataVec ()=0

virtual bool *	getBoolPtr (unsigned int index=0)
	Return a pointer to our internal data, cast as a bool pointer. More...

virtual char *	getCharPtr (unsigned int index=0)
	Return a pointer to our internal data, cast as a char pointer. More...

virtual Complex< float >::Data *	getComplexFloatPtr (unsigned int index=0)
	Return a pointer to our internal data, cast as a Complex<float> pointer. More...

virtual RegDate::Data *	getDatePtr (unsigned int index=0)
	Return a pointer to our internal data, cast as a Date pointer. More...

virtual double *	getDoublePtr (unsigned int index=0)
	Return a pointer to our internal data, cast as a double pointer. More...

virtual float *	getFloatPtr (unsigned int index=0)
	Return a pointer to our internal data, cast as a float pointer. More...

virtual int *	getIntPtr (unsigned int index=0)
	Return a pointer to our internal data, cast as an integer pointer. More...

virtual long *	getLongPtr (unsigned long index=0)
	Return a pointer to our internal data, cast as an integer pointer. More...

void *	getPtr (unsigned int index, DataType::Type type)
	Return an arbitrary pointer to our internal data, cast as the requested type. More...

virtual short *	getShortPtr (unsigned int index=0)
	Return a pointer to our internal data, cast as a short pointer. More...

virtual unsigned char *	getUcharPtr (unsigned int index=0)
	Return a pointer to our internal data, cast as an unsigned char pointer. More...

virtual unsigned int *	getUintPtr (unsigned int index=0)
	Return a pointer to our internal data, cast as an unsigned int pointer. More...

virtual unsigned long *	getUlongPtr (unsigned long index=0)
	Return a pointer to our internal data, cast as an unsigned long pointer. More...

virtual unsigned short *	getUshortPtr (unsigned int index=0)
	Return a pointer to our internal data, cast as an unsigned short pointer. More...

void	incrementRunningAvgCounter ()

void	lock ()
	Lock the frame. More...

unsigned int	nByte ()
	Return the number of bytes in the internal buffer. More...

unsigned int	nReg ()
	Return the number of registers in the internal buffer. More...

virtual void	operator= (DataFrame &frame)
	Define an overloadable operator for assignment. More...

virtual unsigned char &	operator[] (unsigned int index)
	Define an operator for accessing elements of the frame buffer. More...

void	pack (void *data, AxisRange &range, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack an array into our internal memory. More...

void	pack (void *data, unsigned ndata, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack an array into our internal memory from consecutive locations in the input data array. More...

void	packValue (void *data, AxisRange &range, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack a single value for all elements of an array. More...

void	packValue (void *data, unsigned ndata, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Pack a single value for all elements of an array. More...

void	resetRunningAvgCounter ()

virtual void	resize (unsigned int nBuffer)
	Resize the internal buffer. More...

virtual unsigned int	size ()=0
	Return the size of the internal buffer. More...

void	unlock ()
	Unlock the frame. More...

void	unpack (void *data, AxisRange &range, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Unpack an array from our internal memory. More...

void	unpack (void *data, unsigned ndata, DataType::Type type, unsigned iStart, bool lockFrame=true)
	Unpack an array from our internal memory to consecutive locations in the output data array. More...

virtual	~DataFrame ()
	Destructor. More...

Public Attributes
unsigned	nAvg_

Detailed Description

A generic interface for a data frame consisting of contiguous blocks of arbitrary-sized types.

Contains pure virtual methods, so it cannot be instantiated.

Definition at line 27 of file DataFrame.h.

Constructor & Destructor Documentation

sza::util::DataFrame::DataFrame ( )

Constructors.

virtual sza::util::DataFrame::~DataFrame ( )

virtual

Destructor.

Member Function Documentation

void sza::util::DataFrame::addRunningAverage	(	void *	data,
		AxisRange &	range,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack an array into our internal memory.

void sza::util::DataFrame::addRunningAverage	(	void *	data,
		unsigned	ndata,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack an array into our internal memory from consecutive locations in the input data array.

void sza::util::DataFrame::addSum	(	void *	data,
		AxisRange &	range,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack an array into our internal memory.

void sza::util::DataFrame::addSum	(	void *	data,
		unsigned	ndata,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack an array into our internal memory from consecutive locations in the input data array.

void sza::util::DataFrame::addUnion	(	void *	data,
		AxisRange &	range,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack an array into our internal memory.

void sza::util::DataFrame::addUnion	(	void *	data,
		unsigned	ndata,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack an array into our internal memory from consecutive locations in the input data array.

virtual unsigned char* sza::util::DataFrame::data ( )

pure virtual

Get a pointer to our internal data suitable for using as an external network buffer.

virtual bool* sza::util::DataFrame::getBoolPtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as a bool pointer.

virtual char* sza::util::DataFrame::getCharPtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as a char pointer.

virtual Complex<float>::Data* sza::util::DataFrame::getComplexFloatPtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as a Complex<float> pointer.

virtual RegDate::Data* sza::util::DataFrame::getDatePtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as a Date pointer.

virtual double* sza::util::DataFrame::getDoublePtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as a double pointer.

virtual float* sza::util::DataFrame::getFloatPtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as a float pointer.

virtual int* sza::util::DataFrame::getIntPtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as an integer pointer.

virtual long* sza::util::DataFrame::getLongPtr ( unsigned long index = 0 )

virtual

Return a pointer to our internal data, cast as an integer pointer.

void* sza::util::DataFrame::getPtr	(	unsigned int	index,
		DataType::Type	type
	)

Return an arbitrary pointer to our internal data, cast as the requested type.

Calls the following type-specific methods under the hood.

virtual short* sza::util::DataFrame::getShortPtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as a short pointer.

virtual unsigned char* sza::util::DataFrame::getUcharPtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as an unsigned char pointer.

virtual unsigned int* sza::util::DataFrame::getUintPtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as an unsigned int pointer.

virtual unsigned long* sza::util::DataFrame::getUlongPtr ( unsigned long index = 0 )

virtual

Return a pointer to our internal data, cast as an unsigned long pointer.

virtual unsigned short* sza::util::DataFrame::getUshortPtr ( unsigned int index = 0 )

virtual

Return a pointer to our internal data, cast as an unsigned short pointer.

void sza::util::DataFrame::lock ( )

Lock the frame.

unsigned int sza::util::DataFrame::nByte ( )

Return the number of bytes in the internal buffer.

unsigned int sza::util::DataFrame::nReg ( )

Return the number of registers in the internal buffer.

virtual void sza::util::DataFrame::operator= ( DataFrame & frame )

virtual

Define an overloadable operator for assignment.

virtual unsigned char& sza::util::DataFrame::operator[] ( unsigned int index )

virtual

Define an operator for accessing elements of the frame buffer.

void sza::util::DataFrame::pack	(	void *	data,
		AxisRange &	range,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack an array into our internal memory.

void sza::util::DataFrame::pack	(	void *	data,
		unsigned	ndata,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack an array into our internal memory from consecutive locations in the input data array.

void sza::util::DataFrame::packValue	(	void *	data,
		AxisRange &	range,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack a single value for all elements of an array.

void sza::util::DataFrame::packValue	(	void *	data,
		unsigned	ndata,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Pack a single value for all elements of an array.

virtual void sza::util::DataFrame::resize ( unsigned int nBuffer )

virtual

Resize the internal buffer.

This can't be pure virtual, since I call it from the constructor.

virtual unsigned int sza::util::DataFrame::size ( )

pure virtual

Return the size of the internal buffer.

void sza::util::DataFrame::unlock ( )

Unlock the frame.

void sza::util::DataFrame::unpack	(	void *	data,
		AxisRange &	range,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Unpack an array from our internal memory.

void sza::util::DataFrame::unpack	(	void *	data,
		unsigned	ndata,
		DataType::Type	type,
		unsigned	iStart,
		bool	lockFrame = `true`
	)

Unpack an array from our internal memory to consecutive locations in the output data array.

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

carma/szautil/DataFrame.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation