#include <DataFrame.h>

Inheritance diagram for gcp::util::DataFrame:

Public Member Functions
	DataFrame ()

virtual	~DataFrame ()

virtual void	resize (unsigned int nBuffer)

virtual unsigned int	size ()=0

unsigned int	nReg ()

unsigned int	nByte ()

virtual unsigned char &	operator[] (unsigned int index)

virtual void	operator= (DataFrame &frame)

virtual unsigned char *	data ()=0

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

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

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

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

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

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

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

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

void	resetRunningAvgCounter ()

void	incrementRunningAvgCounter ()

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

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

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

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

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

virtual bool *	getBoolPtr (unsigned int index=0)

virtual unsigned char *	getUcharPtr (unsigned int index=0)

virtual char *	getCharPtr (unsigned int index=0)

virtual unsigned short *	getUshortPtr (unsigned int index=0)

virtual short *	getShortPtr (unsigned int index=0)

virtual unsigned int *	getUintPtr (unsigned int index=0)

virtual int *	getIntPtr (unsigned int index=0)

virtual unsigned long *	getUlongPtr (unsigned long index=0)

virtual long *	getLongPtr (unsigned long index=0)

virtual float *	getFloatPtr (unsigned int index=0)

virtual double *	getDoublePtr (unsigned int index=0)

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

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

void	lock ()

void	unlock ()

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.

Constructor & Destructor Documentation

DataFrame::DataFrame ( )

Constructors.

DataFrame::~DataFrame ( )

virtual

Destructor.

Member Function Documentation

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

Pack an array into our internal memory

....................................................................... Sum an array into internal memory

void 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.

....................................................................... Pack an array into internal memory from consecutive elements of the input data array.

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

Pack an array into our internal memory

....................................................................... Sum an array into internal memory

void 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.

....................................................................... Pack an array into internal memory from consecutive elements of the input data array.

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

Pack an array into our internal memory

....................................................................... Sum an array into internal memory

void 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.

....................................................................... Pack an array into internal memory from consecutive elements of the input data array.

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

pure virtual

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

Implemented in gcp::util::AntennaDataFrameCorba, and gcp::util::DataFrameNormal.

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

virtual

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

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

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

virtual

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

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

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

virtual

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

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

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

virtual

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

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

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

virtual

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

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

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

virtual

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

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

int * DataFrame::getIntPtr ( unsigned int index = 0 )

virtual

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

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

long * DataFrame::getLongPtr ( unsigned long index = 0 )

virtual

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

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

void * 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.

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

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

virtual

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

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

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

virtual

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

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

unsigned int * DataFrame::getUintPtr ( unsigned int index = 0 )

virtual

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

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

unsigned long * DataFrame::getUlongPtr ( unsigned long index = 0 )

virtual

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

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

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

virtual

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

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

void DataFrame::incrementRunningAvgCounter ( )

....................................................................... Incremen the counter which will be used for running averages

void DataFrame::lock ( )

Lock the frame

....................................................................... Lock the frame.

unsigned int DataFrame::nByte ( )

Return the number of bytes in the internal buffer.

....................................................................... Return the number of bytes in the internal buffer.

unsigned int DataFrame::nReg ( )

Return the number of registers in the internal buffer.

....................................................................... Return the number of registers in the internal buffer.

void DataFrame::operator= ( DataFrame & frame )

virtual

Define an overloadable operator for assignment

Empty body for virtual assignment operator.

Reimplemented in gcp::util::DataFrameNormal.

unsigned char & DataFrame::operator[] ( unsigned int nBuffer )

virtual

Define an operator for accessing elements of the frame buffer.

Empty body for virtual index operator

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

Pack an array into our internal memory

....................................................................... Pack an array into internal memory

void 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.

....................................................................... Pack an array into internal memory from consecutive elements of the input data array.

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

Pack a single value for all elements of an array

....................................................................... Pack an array into internal memory

void gcp::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

void DataFrame::resetRunningAvgCounter ( )

....................................................................... Reset the counter which will be used for running averages

void DataFrame::resize ( unsigned int nBuffer )

virtual

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

Set the size of the buffer managed by this frame,

Reimplemented in gcp::util::AntennaDataFrameCorba, and gcp::util::DataFrameNormal.

unsigned int DataFrame::size ( )

pure virtual

Return the size of the internal buffer.

Return the size of the buffer managed by this frame,

Implemented in gcp::util::AntennaDataFrameCorba, and gcp::util::DataFrameNormal.

void DataFrame::unlock ( )

Unlock the frame

....................................................................... Unlock the frame.

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

Unpack an array from our internal memory

....................................................................... Unpack an array from internal memory

void 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.

....................................................................... Unpack an array from consecutive elements of the internal memory

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

gcpCbass/util/common/DataFrame.h
gcpCbass/util/common/DataFrame.cc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation