MNE-CPP  beta 1.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
MNEX::IAlgorithm Class Referenceabstract

The IAlgorithm class provides an interface for a real-time algorithm plugin. More...

#include <IAlgorithm.h>

Inheritance diagram for MNEX::IAlgorithm:
MNEX::IPlugin AveragingPlugin::Averaging BCIPlugin::BCI CovariancePlugin::Covariance DummyToolboxPlugin::DummyToolbox MNEPlugin::MNE NoiseEstimatePlugin::NoiseEstimate RapMusicToolboxPlugin::RapMusicToolbox RtHpiPlugin::RtHpi RtSssPlugin::RtSss TriggerControlPlugin::TriggerControl

Public Types

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
 

Public Member Functions

virtual ~IAlgorithm ()
 
virtual QSharedPointer< IPluginclone () const =0
 
virtual void init ()=0
 
virtual void unload ()=0
 
virtual bool start ()=0
 
virtual bool stop ()=0
 
virtual PluginType getType () const =0
 
virtual QString getName () const =0
 
virtual bool multiInstanceAllowed () const
 
virtual QWidget * setupWidget ()=0
 
- Public Member Functions inherited from MNEX::IPlugin
virtual ~IPlugin ()
 
QList< QAction * > getPluginActions ()
 
InputConnectorListgetInputConnectors ()
 
OutputConnectorListgetOutputConnectors ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from MNEX::IPlugin
InputConnectorList m_inputConnectors
 
OutputConnectorList m_outputConnectors
 

Detailed Description

The IAlgorithm class provides an interface for a real-time algorithm plugin.

DECLARE CLASS IAlgorithm

Definition at line 70 of file IAlgorithm.h.

Member Typedef Documentation

typedef QSharedPointer<const IAlgorithm> MNEX::IAlgorithm::ConstSPtr

Const shared pointer type for IAlgorithm.

Definition at line 75 of file IAlgorithm.h.

typedef QSharedPointer<IAlgorithm> MNEX::IAlgorithm::SPtr

Shared pointer type for IAlgorithm.

Definition at line 74 of file IAlgorithm.h.

Constructor & Destructor Documentation

virtual MNEX::IAlgorithm::~IAlgorithm ( )
inlinevirtual

Destroys the IAlgorithm.

Definition at line 81 of file IAlgorithm.h.

Member Function Documentation

virtual QSharedPointer<IPlugin> MNEX::IAlgorithm::clone ( ) const
pure virtual
virtual QString MNEX::IAlgorithm::getName ( ) const
pure virtual
virtual PluginType MNEX::IAlgorithm::getType ( ) const
pure virtual
virtual void MNEX::IAlgorithm::init ( )
pure virtual
bool MNEX::IAlgorithm::multiInstanceAllowed ( ) const
inlinevirtual

True if multi instantiation of plugin is allowed.

Returns
true if multi instantiation of plugin is allowed.

Implements MNEX::IPlugin.

Definition at line 169 of file IAlgorithm.h.

virtual void MNEX::IAlgorithm::run ( )
protectedpure virtual

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::IPlugin.

Implemented in BCIPlugin::BCI, TriggerControlPlugin::TriggerControl, MNEPlugin::MNE, AveragingPlugin::Averaging, RapMusicToolboxPlugin::RapMusicToolbox, RtHpiPlugin::RtHpi, NoiseEstimatePlugin::NoiseEstimate, CovariancePlugin::Covariance, RtSssPlugin::RtSss, and DummyToolboxPlugin::DummyToolbox.

virtual QWidget* MNEX::IAlgorithm::setupWidget ( )
pure virtual

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

Returns
the setup widget.

Implements MNEX::IPlugin.

Implemented in AveragingPlugin::Averaging, TriggerControlPlugin::TriggerControl, MNEPlugin::MNE, BCIPlugin::BCI, RapMusicToolboxPlugin::RapMusicToolbox, NoiseEstimatePlugin::NoiseEstimate, and CovariancePlugin::Covariance.

virtual bool MNEX::IAlgorithm::start ( )
pure virtual
virtual bool MNEX::IAlgorithm::stop ( )
pure virtual
virtual void MNEX::IAlgorithm::unload ( )
pure virtual

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