MNE-CPP  beta 1.0
Public Types | Public Member Functions | List of all members
XMEASLIB::NewRealTimeSampleArray Class Reference

The NewRealTimeSampleArray class is the base class of every NewRealTimeSampleArray Measurement. More...

#include <newrealtimesamplearray.h>

Inheritance diagram for XMEASLIB::NewRealTimeSampleArray:
XMEASLIB::NewMeasurement

Public Types

typedef QSharedPointer< NewRealTimeSampleArraySPtr
 
typedef QSharedPointer< const NewRealTimeSampleArrayConstSPtr
 
- Public Types inherited from XMEASLIB::NewMeasurement
typedef QSharedPointer< NewMeasurementSPtr
 
typedef QSharedPointer< const NewMeasurementConstSPtr
 

Public Member Functions

 NewRealTimeSampleArray (QObject *parent=0)
 
virtual ~NewRealTimeSampleArray ()
 
void clear ()
 
void setMinValue (double minValue)
 
double getMinValue () const
 
void setMaxValue (double maxValue)
 
double getMaxValue () const
 
void setSamplingRate (double dSamplingRate)
 
double getSamplingRate () const
 
void setArraySize (unsigned char ucArraySize)
 
unsigned char getArraySize () const
 
const QVector< double > & getSampleArray ()
 
void setUnit (const QString &unit)
 
const QString & getUnit () const
 
virtual void setValue (double v)
 
virtual double getValue () const
 
- Public Member Functions inherited from XMEASLIB::NewMeasurement
 NewMeasurement (int type=QMetaType::UnknownType, QObject *parent=0)
 
virtual ~NewMeasurement ()
 
const QString & getName () const
 
void setName (const QString &name)
 
bool isVisible () const
 
void setVisibility (bool visibility)
 
int type () const
 

Additional Inherited Members

- Signals inherited from XMEASLIB::NewMeasurement
void notify ()
 
- Protected Member Functions inherited from XMEASLIB::NewMeasurement
void setType (int type)
 

Detailed Description

The NewRealTimeSampleArray class is the base class of every NewRealTimeSampleArray Measurement.

DECLARE CLASS NewRealTimeSampleArray

Definition at line 82 of file newrealtimesamplearray.h.

Member Typedef Documentation

Const shared pointer type for NewRealTimeSampleArray.

Definition at line 87 of file newrealtimesamplearray.h.

Shared pointer type for NewRealTimeSampleArray.

Definition at line 86 of file newrealtimesamplearray.h.

Constructor & Destructor Documentation

NewRealTimeSampleArray::NewRealTimeSampleArray ( QObject *  parent = 0)

Constructs a NewRealTimeSampleArray.

Parameters
[in]parentthe QObject parent of this measurement

Definition at line 64 of file newrealtimesamplearray.cpp.

NewRealTimeSampleArray::~NewRealTimeSampleArray ( )
virtual

Destroys the NewRealTimeSampleArray.

Definition at line 79 of file newrealtimesamplearray.cpp.

Member Function Documentation

void XMEASLIB::NewRealTimeSampleArray::clear ( )
inline

Clears all the data stored in the buffer.

Definition at line 233 of file newrealtimesamplearray.h.

unsigned char XMEASLIB::NewRealTimeSampleArray::getArraySize ( ) const
inline

Returns the number of values which should be gathered before attached observers are notified by calling the Subject notify() method.

Returns
the number of values which are gathered before a notify() is called.

Definition at line 306 of file newrealtimesamplearray.h.

double XMEASLIB::NewRealTimeSampleArray::getMaxValue ( ) const
inline

Returns the maximal value.

Returns
the maximal value.

Definition at line 266 of file newrealtimesamplearray.h.

double XMEASLIB::NewRealTimeSampleArray::getMinValue ( ) const
inline

Returns the minimal value.

Returns
the minimal value.

Definition at line 248 of file newrealtimesamplearray.h.

const QVector< double > & XMEASLIB::NewRealTimeSampleArray::getSampleArray ( )
inline

Returns the gathered sample array vector.

Returns
the current sample array vector.

Definition at line 315 of file newrealtimesamplearray.h.

double XMEASLIB::NewRealTimeSampleArray::getSamplingRate ( ) const
inline

Returns the sampling rate of the NewRealTimeSampleArray Measurement.

Returns
the sampling rate of the NewRealTimeSampleArray.

Definition at line 284 of file newrealtimesamplearray.h.

const QString & XMEASLIB::NewRealTimeSampleArray::getUnit ( ) const
inline

Returns the unit of the NewRealTimeSampleArray measurement.

Returns
the unit of the data of measurement.

Definition at line 333 of file newrealtimesamplearray.h.

double NewRealTimeSampleArray::getValue ( ) const
virtual

Returns the current value set. This method is inherited by Measurement.

Returns
the last attached value.

Definition at line 87 of file newrealtimesamplearray.cpp.

void XMEASLIB::NewRealTimeSampleArray::setArraySize ( unsigned char  ucArraySize)
inline

Sets the number of values which should be gathered before attached observers are notified by calling the Subject notify() method.

Parameters
[in]ucArraySizethe number of values.

Definition at line 293 of file newrealtimesamplearray.h.

void XMEASLIB::NewRealTimeSampleArray::setMaxValue ( double  maxValue)
inline

Sets the maximal value. If value to set is bigger, current value is set to maximal value.

Parameters
[in]maxValuemaximal value.

Definition at line 257 of file newrealtimesamplearray.h.

void XMEASLIB::NewRealTimeSampleArray::setMinValue ( double  minValue)
inline

Sets the minimal value. If current value to set is smaller, current value is set to minimal value.

Parameters
[in]minValueminimal value.

Definition at line 239 of file newrealtimesamplearray.h.

void XMEASLIB::NewRealTimeSampleArray::setSamplingRate ( double  dSamplingRate)
inline

Sets the sampling rate of the NewRealTimeSampleArray Measurement.

Parameters
[in]dSamplingRatethe sampling rate of the NewRealTimeSampleArray.

Definition at line 275 of file newrealtimesamplearray.h.

void XMEASLIB::NewRealTimeSampleArray::setUnit ( const QString &  unit)
inline

Sets the unit of the NewRealTimeSampleArray data.

Parameters
[in]unitof the data.

Definition at line 324 of file newrealtimesamplearray.h.

void NewRealTimeSampleArray::setValue ( double  v)
virtual

Attaches a value to the sample array vector. This method is inherited by Measurement.

Parameters
[in]vthe value which is attached to the sample array vector.

Definition at line 96 of file newrealtimesamplearray.cpp.


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