ACQ2XX_API
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
Frame Class Reference

#include <Frame.h>

Inheritance diagram for Frame:
ConcreteFrame< T >

Public Member Functions

 Frame (const AcqType &acqType)
virtual ~Frame ()
const Tag getTag (int isam) const
virtual unsigned getID (void) const
 < return ID (frame number).
enum STATE getState (void)
int sampleSize (void) const
int lineSize (void) const
int frameSize (void) const
long long getStartSampleNumber (void) const
unsigned char getDIO (void) const
unsigned short getExtra (void) const

Static Public Member Functions

static int buildFrame (unsigned id, Frame *frame, void *raw, int nraw)

Protected Types

enum  STATE { EMPTY, FULL, INVALID }

Protected Member Functions

virtual int fillData (void *raw, int nraw)=0
int appendTag (int isam, unsigned short tag)
void computeStartSampleNumber ()
void reset (void)

Protected Attributes

const AcqTypeacqType
enum Frame::STATE state
unsigned id
Tag tags [FRAME_SAMPLES]
int nchan
int word_size
long long startSampleNumber

Detailed Description

Definition at line 37 of file Frame.h.


Member Enumeration Documentation

enum Frame::STATE [protected]
Enumerator:
EMPTY 
FULL 
INVALID 

Definition at line 41 of file Frame.h.


Constructor & Destructor Documentation

Frame::Frame ( const AcqType acqType)

Definition at line 36 of file Frame.cpp.

Frame::~Frame ( ) [virtual]

Definition at line 43 of file Frame.cpp.


Member Function Documentation

int Frame::appendTag ( int  isam,
unsigned short  tag 
) [protected]

Definition at line 83 of file Frame.cpp.

References computeStartSampleNumber(), error(), FRAME_SAMPLES, FULL, INVALID, nx_bit(), state, and tags.

int Frame::buildFrame ( unsigned  id,
Frame frame,
void *  raw,
int  nraw 
) [static]

Definition at line 128 of file Frame.cpp.

References EMPTY, fillData(), id, and state.

Referenced by Dt100Transport::readStreamingFrame().

void Frame::computeStartSampleNumber ( void  ) [protected]

Definition at line 51 of file Frame.cpp.

References nx_bit(), startSampleNumber, and tags.

Referenced by appendTag().

virtual int Frame::fillData ( void *  raw,
int  nraw 
) [protected, pure virtual]

Implemented in ConcreteFrame< T >.

Referenced by buildFrame().

int Frame::frameSize ( void  ) const [inline]

Definition at line 82 of file Frame.h.

References FRAME_SAMPLES, and lineSize().

Referenced by Dt100Transport::readStreamingFrame().

unsigned char Frame::getDIO ( void  ) const

Definition at line 78 of file Frame.cpp.

References tags.

unsigned short Frame::getExtra ( void  ) const

Definition at line 65 of file Frame.cpp.

References nx_bit(), and tags.

virtual unsigned Frame::getID ( void  ) const [inline, virtual]

< return ID (frame number).

Definition at line 66 of file Frame.h.

References id.

Referenced by FrameTimer::onFrame().

long long Frame::getStartSampleNumber ( void  ) const [inline]

Definition at line 86 of file Frame.h.

References FULL, startSampleNumber, and state.

Referenced by FrameTimer::onFrame(), and ConcreteDataStreamer< T >::streamData().

enum STATE Frame::getState ( void  ) [inline]

Definition at line 71 of file Frame.h.

References state.

const Tag Frame::getTag ( int  isam) const [inline]

Definition at line 63 of file Frame.h.

References tags.

int Frame::lineSize ( void  ) const [inline]

Definition at line 79 of file Frame.h.

References sampleSize().

Referenced by frameSize().

void Frame::reset ( void  ) [inline, protected]

Definition at line 56 of file Frame.h.

References EMPTY, and state.

int Frame::sampleSize ( void  ) const [inline]

Definition at line 75 of file Frame.h.

References nchan, and word_size.

Referenced by lineSize(), and Dt100Transport::readStreamingFrame().


Field Documentation

const AcqType& Frame::acqType [protected]

Definition at line 39 of file Frame.h.

Referenced by ConcreteFrame< T >::ConcreteFrame().

unsigned Frame::id [protected]

Definition at line 44 of file Frame.h.

Referenced by buildFrame(), and getID().

int Frame::nchan [protected]

Definition at line 47 of file Frame.h.

Referenced by sampleSize().

long long Frame::startSampleNumber [protected]

Definition at line 53 of file Frame.h.

Referenced by computeStartSampleNumber(), and getStartSampleNumber().

enum Frame::STATE Frame::state [protected]
Tag Frame::tags[FRAME_SAMPLES] [protected]

Definition at line 46 of file Frame.h.

Referenced by appendTag(), computeStartSampleNumber(), getDIO(), getExtra(), and getTag().

int Frame::word_size [protected]

Definition at line 48 of file Frame.h.

Referenced by sampleSize().


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