MNE-CPP  beta 0.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
XMEASLIB::RealTimeMultiSampleArray Class Reference

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

#include <realtimemultisamplearray.h>

Inheritance diagram for XMEASLIB::RealTimeMultiSampleArray:
XMEASLIB::SngChnMeasurement XMEASLIB::Measurement Subject

Public Types

typedef QSharedPointer
< RealTimeMultiSampleArray
SPtr
 
typedef QSharedPointer< const
RealTimeMultiSampleArray
ConstSPtr
 
- Public Types inherited from XMEASLIB::SngChnMeasurement
typedef QSharedPointer
< SngChnMeasurement
SPtr
 
typedef QSharedPointer< const
SngChnMeasurement
ConstSPtr
 
- Public Types inherited from XMEASLIB::Measurement
typedef QSharedPointer
< Measurement
SPtr
 
typedef QSharedPointer< const
Measurement
ConstSPtr
 
- Public Types inherited from Subject
typedef QSharedPointer< SubjectSPtr
 
typedef QSharedPointer< const
Subject
ConstSPtr
 
typedef QSet< IObserver * > t_Observers
 

Public Member Functions

 RealTimeMultiSampleArray (unsigned int uiNumChannels)
 
virtual ~RealTimeMultiSampleArray ()
 
void setMinValue (double minValue)
 
double getMinValue () const
 
void setMaxValue (double maxValue)
 
double getMaxValue () const
 
void setSamplingRate (double dSamplingRate)
 
double getSamplingRate () const
 
void setNumChannels (unsigned int uiNumChannels)
 
unsigned int getNumChannels () const
 
void setMultiArraySize (unsigned char ucMultiArraySize)
 
unsigned char getMultiArraySize () const
 
const QVector< QVector< double > > & getMultiSampleArray ()
 
void setUnit (const QString &unit)
 
const QString & getUnit () const
 
virtual void setValue (double)
 
virtual double getValue () const
 
virtual void setVector (QVector< double > v)
 
virtual QVector< double > getVector () const
 
- Public Member Functions inherited from XMEASLIB::SngChnMeasurement
 SngChnMeasurement ()
 
virtual ~SngChnMeasurement ()
 
virtual bool isSingleChannel () const
 
- Public Member Functions inherited from XMEASLIB::Measurement
 Measurement ()
 
virtual ~Measurement ()
 
void setName (const QString &name)
 
QString getName () const
 
void setVisibility (bool visibility)
 
bool isVisible () const
 
- Public Member Functions inherited from Subject
virtual ~Subject ()
 
void attach (IObserver *pObserver)
 
void detach (IObserver *pObserver)
 
void notify ()
 
t_Observersobservers ()
 
int observerNumDebug ()
 

Additional Inherited Members

- Static Public Attributes inherited from Subject
static bool notifyEnabled = true
 
- Protected Member Functions inherited from Subject
 Subject ()
 

Detailed Description

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

DECLARE CLASS RealTimeMultiSampleArray

Definition at line 81 of file realtimemultisamplearray.h.

Member Typedef Documentation

Const shared pointer type for RealTimeMultiSampleArray.

Definition at line 85 of file realtimemultisamplearray.h.

Shared pointer type for RealTimeMultiSampleArray.

Definition at line 84 of file realtimemultisamplearray.h.

Constructor & Destructor Documentation

RealTimeMultiSampleArray::RealTimeMultiSampleArray ( unsigned int  uiNumChannels)

Constructs a RealTimeMultiSampleArray.

Parameters
[in]uiNumChannelsthe number of channels.

Definition at line 66 of file realtimemultisamplearray.cpp.

RealTimeMultiSampleArray::~RealTimeMultiSampleArray ( )
virtual

Destroys the RealTimeMultiSampleArray.

Definition at line 82 of file realtimemultisamplearray.cpp.

Member Function Documentation

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

Returns the maximal value.

Returns
the maximal value.

Definition at line 273 of file realtimemultisamplearray.h.

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

Returns the minimal value.

Returns
the minimal value.

Definition at line 257 of file realtimemultisamplearray.h.

unsigned char XMEASLIB::RealTimeMultiSampleArray::getMultiArraySize ( ) 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 324 of file realtimemultisamplearray.h.

const QVector< QVector< double > > & XMEASLIB::RealTimeMultiSampleArray::getMultiSampleArray ( )
inline

Returns the gathered multi sample array.

Returns
the current multi sample array.

Definition at line 332 of file realtimemultisamplearray.h.

unsigned int XMEASLIB::RealTimeMultiSampleArray::getNumChannels ( ) const
inline

Returns the number of channels of .

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

Definition at line 305 of file realtimemultisamplearray.h.

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

Returns the sampling rate of the RealTimeMultiSampleArray Measurement.

Returns
the sampling rate of the RealTimeMultiSampleArray.

Definition at line 289 of file realtimemultisamplearray.h.

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

Returns the unit of the RealTimeMultiSampleArray measurement.

Returns
the unit of the data of measurement.

Definition at line 348 of file realtimemultisamplearray.h.

virtual double XMEASLIB::RealTimeMultiSampleArray::getValue ( ) const
inlinevirtual

Not used. This method is inherited by Measurement.

Returns
always -1, because values are not used.

Implements XMEASLIB::SngChnMeasurement.

Definition at line 213 of file realtimemultisamplearray.h.

QVector< double > RealTimeMultiSampleArray::getVector ( ) const
virtual

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

Returns
the last attached value.

Definition at line 90 of file realtimemultisamplearray.cpp.

void XMEASLIB::RealTimeMultiSampleArray::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 265 of file realtimemultisamplearray.h.

void XMEASLIB::RealTimeMultiSampleArray::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 249 of file realtimemultisamplearray.h.

void XMEASLIB::RealTimeMultiSampleArray::setMultiArraySize ( unsigned char  ucMultiArraySize)
inline

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

Parameters
[in]ucMultiArraySizethe number of values.

Definition at line 312 of file realtimemultisamplearray.h.

void XMEASLIB::RealTimeMultiSampleArray::setNumChannels ( unsigned int  uiNumChannels)
inline

Sets the number of channels of .

Parameters
[in]uiNumChannelsthe number of channels.

Definition at line 297 of file realtimemultisamplearray.h.

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

Sets the sampling rate of the RealTimeMultiSampleArray Measurement.

Parameters
[in]dSamplingRatethe sampling rate of the RealTimeMultiSampleArray.

Definition at line 281 of file realtimemultisamplearray.h.

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

Sets the unit of the RealTimeMultiSampleArray data.

Parameters
[in]unitof the data.

Definition at line 340 of file realtimemultisamplearray.h.

virtual void XMEASLIB::RealTimeMultiSampleArray::setValue ( double  )
inlinevirtual

Not used. This method is inherited by Measurement.

Parameters
[in]notused

Implements XMEASLIB::SngChnMeasurement.

Definition at line 205 of file realtimemultisamplearray.h.

void RealTimeMultiSampleArray::setVector ( QVector< 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 98 of file realtimemultisamplearray.cpp.


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