CARMA C++
sza::util::AntennaDataFrameNormal Class Reference

This is just a normal data frame, with an additional member which specifies the antenna. More...

#include <carma/szautil/AntennaDataFrameNormal.h>

Inherits sza::util::AntennaDataFrame, and sza::util::DataFrameNormal.

Public Member Functions

 AntennaDataFrameNormal (unsigned int nBuffer)
 Constructor. More...
 
void operator= (sza::util::DataFrameNormal &frame)
 Assignment operators. More...
 
void operator= (AntennaDataFrameNormal &frame)
 
- Public Member Functions inherited from sza::util::AntennaDataFrame
 AntennaDataFrame ()
 Constructor. More...
 
 AntennaDataFrame (const sza::util::AntNum &antNum)
 Constructor. More...
 
unsigned char * data ()
 Get a pointer to our internal data suitable for using as an external network buffer. More...
 
AntNum getAnt ()
 Return the antenna id associated with this data frame. More...
 
unsigned getAntIntId ()
 Return the antenna id associated with this data frame. More...
 
void operator= (AntennaDataFrame &frame)
 Assignment operators. More...
 
virtual void setAnt (unsigned int)
 Set the antenna id associated with this data frame. More...
 
virtual void setAnt (sza::util::AntNum::Id antennaId)
 Set the antenna id associated with this data frame. More...
 
virtual void setAnt (const sza::util::AntNum &antNum)
 Set by reference. More...
 
virtual ~AntennaDataFrame ()
 Destructor. More...
 
- Public Member Functions inherited from sza::util::DataFrameNormal
virtual unsigned char * data ()
 Get a pointer to our internal data suitable for using as an external network buffer. More...
 
 DataFrameNormal ()
 Constructors. More...
 
 DataFrameNormal (unsigned int nBuffer)
 Constructor with buffer initialization. More...
 
virtual std::vector< unsigned
char > & 
dataVec ()
 
virtual void operator= (DataFrame &frame)
 Assignment operators, base-class and local. More...
 
virtual void operator= (DataFrameNormal &frame)
 
unsigned char & operator[] (unsigned index)
 Return a reference to a requested element. More...
 
void resize (unsigned int nBuffer)
 Resize the internal buffer. More...
 
unsigned int size ()
 Return the size of the internal buffer. More...
 
virtual ~DataFrameNormal ()
 Destructor. More...
 
- Public Member Functions inherited from sza::util::DataFrame
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...
 

Additional Inherited Members

- Public Attributes inherited from sza::util::DataFrame
unsigned nAvg_
 
- Protected Attributes inherited from sza::util::AntennaDataFrame
sza::util::AntNum antNum_
 

Detailed Description

This is just a normal data frame, with an additional member which specifies the antenna.

Definition at line 21 of file AntennaDataFrameNormal.h.

Constructor & Destructor Documentation

sza::util::AntennaDataFrameNormal::AntennaDataFrameNormal ( unsigned int  nBuffer)

Constructor.

Member Function Documentation

void sza::util::AntennaDataFrameNormal::operator= ( sza::util::DataFrameNormal &  frame)

Assignment operators.


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