MNE-CPP  beta 1.0
Signals | Public Member Functions | Protected Member Functions | List of all members
AveragingPlugin::Averaging Class Reference

The Averaging class provides a Averaging algorithm structure. More...

#include <averaging.h>

Inheritance diagram for AveragingPlugin::Averaging:
MNEX::IAlgorithm MNEX::IPlugin

Signals

void fiffInfoAvailable ()
 

Public Member Functions

 Averaging ()
 
 ~Averaging ()
 
virtual void init ()
 
virtual void unload ()
 
void changeNumAverages (qint32 numAve)
 
virtual QSharedPointer< IPluginclone () const
 
virtual bool start ()
 
virtual bool stop ()
 
virtual IPlugin::PluginType getType () const
 
virtual QString getName () const
 
void changeStimChannel (qint32 index)
 
void changePreStim (qint32 samples)
 
void changePostStim (qint32 samples)
 
void appendEvoked (FiffEvoked::SPtr p_pEvoked)
 
virtual QWidget * setupWidget ()
 
void update (XMEASLIB::NewMeasurement::SPtr pMeasurement)
 
void showAveragingWidget ()
 
- Public Member Functions inherited from MNEX::IAlgorithm
virtual ~IAlgorithm ()
 
virtual bool multiInstanceAllowed () const
 
- Public Member Functions inherited from MNEX::IPlugin
virtual ~IPlugin ()
 
QList< QAction * > getPluginActions ()
 
InputConnectorListgetInputConnectors ()
 
OutputConnectorListgetOutputConnectors ()
 

Protected Member Functions

virtual void run ()
 
- Protected Member Functions inherited from MNEX::IPlugin
void addPluginAction (QAction *pAction)
 

Additional Inherited Members

- Public Types inherited from MNEX::IAlgorithm
typedef QSharedPointer< IAlgorithmSPtr
 
typedef QSharedPointer< const IAlgorithmConstSPtr
 
- Public Types inherited from MNEX::IPlugin
enum  PluginType { _ISensor, _IAlgorithm, _IIO, _PluginSet }
 
typedef QSharedPointer< IPluginSPtr
 
typedef QSharedPointer< const IPluginConstSPtr
 
typedef QVector< QSharedPointer< PluginInputConnector > > InputConnectorList
 
typedef QVector< QSharedPointer< PluginOutputConnector > > OutputConnectorList
 
- Protected Attributes inherited from MNEX::IPlugin
InputConnectorList m_inputConnectors
 
OutputConnectorList m_outputConnectors
 

Detailed Description

The Averaging class provides a Averaging algorithm structure.

DECLARE CLASS Averaging

Definition at line 109 of file averaging.h.

Constructor & Destructor Documentation

Averaging::Averaging ( )

Constructs a Averaging.

Definition at line 76 of file averaging.cpp.

Averaging::~Averaging ( )

Destroys the Averaging.

Definition at line 105 of file averaging.cpp.

Member Function Documentation

void Averaging::changeNumAverages ( qint32  numAve)

Change the number of averages

Parameters
[in]numAvenew number of averages

Definition at line 173 of file averaging.cpp.

QSharedPointer< IPlugin > Averaging::clone ( ) const
virtual

Clone the plugin

Implements MNEX::IAlgorithm.

Definition at line 114 of file averaging.cpp.

void AveragingPlugin::Averaging::fiffInfoAvailable ( )
signal

Emitted when fiffInfo is available

QString Averaging::getName ( ) const
virtual

Returns the plugin name. Pure virtual method inherited by IPlugin.

Returns
the name of the IAlgorithm.

Implements MNEX::IAlgorithm.

Definition at line 246 of file averaging.cpp.

IPlugin::PluginType Averaging::getType ( ) const
virtual

Returns the plugin type. Pure virtual method inherited by IPlugin.

Returns
type of the IAlgorithm

Implements MNEX::IAlgorithm.

Definition at line 238 of file averaging.cpp.

void Averaging::init ( )
virtual

Initialise input and output connectors.

Implements MNEX::IAlgorithm.

Definition at line 126 of file averaging.cpp.

void Averaging::run ( )
protectedvirtual

The starting point for the thread. After calling start(), the newly created thread calls this function. Returning from this method will end the execution of the thread. Pure virtual method inherited by QThread

Implements MNEX::IAlgorithm.

Definition at line 389 of file averaging.cpp.

QWidget * Averaging::setupWidget ( )
virtual

Returns the set up widget for configuration of IAlgorithm. Pure virtual method inherited by IPlugin.

Returns
the setup widget.

Implements MNEX::IAlgorithm.

Definition at line 287 of file averaging.cpp.

bool Averaging::start ( )
virtual

Starts the IAlgorithm. Pure virtual method inherited by IPlugin.

Returns
true if success, false otherwise

Implements MNEX::IAlgorithm.

Definition at line 195 of file averaging.cpp.

bool Averaging::stop ( )
virtual

Stops the IAlgorithm. Pure virtual method inherited by IPlugin.

Returns
true if success, false otherwise

Implements MNEX::IAlgorithm.

Definition at line 214 of file averaging.cpp.

void Averaging::unload ( )
virtual

Is called when plugin is detached of the stage. Can be used to safe settings.

Implements MNEX::IAlgorithm.

Definition at line 158 of file averaging.cpp.


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