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

The ISensor class provides an interface for a sensor plugin. More...

#include <ISensor.h>

Inheritance diagram for MNEX::ISensor:
MNEX::IPlugin BabyMEGPlugin::BabyMEG ECGSimulatorPlugin::ECGSimulator EEGoSportsPlugin::EEGoSports FiffSimulatorPlugin::FiffSimulator MneRtClientPlugin::Neuromag TMSIPlugin::TMSI

Public Member Functions

virtual ~ISensor ()
 
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

- 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 ISensor class provides an interface for a sensor plugin.

DECLARE CLASS IRTAlgorithm

Definition at line 63 of file ISensor.h.

Constructor & Destructor Documentation

virtual MNEX::ISensor::~ISensor ( )
inlinevirtual

Destroys the ISensor.

Definition at line 72 of file ISensor.h.

Member Function Documentation

virtual QSharedPointer<IPlugin> MNEX::ISensor::clone ( ) const
pure virtual
virtual QString MNEX::ISensor::getName ( ) const
pure virtual
virtual PluginType MNEX::ISensor::getType ( ) const
pure virtual

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

Returns
type of the ISensor

Implements MNEX::IPlugin.

Implemented in BabyMEGPlugin::BabyMEG, EEGoSportsPlugin::EEGoSports, TMSIPlugin::TMSI, MneRtClientPlugin::Neuromag, FiffSimulatorPlugin::FiffSimulator, and ECGSimulatorPlugin::ECGSimulator.

virtual void MNEX::ISensor::init ( )
pure virtual
bool MNEX::ISensor::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 161 of file ISensor.h.

virtual void MNEX::ISensor::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 BabyMEGPlugin::BabyMEG, MneRtClientPlugin::Neuromag, FiffSimulatorPlugin::FiffSimulator, EEGoSportsPlugin::EEGoSports, TMSIPlugin::TMSI, ECGSimulatorPlugin::ECGSimulator, FiffSimulatorPlugin::FiffSimulator, and BabyMEGPlugin::BabyMEG.

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

Returns the set up widget for configuration of ISensor. Pure virtual method inherited by IModule.

Returns
the setup widget.

Implements MNEX::IPlugin.

Implemented in BabyMEGPlugin::BabyMEG, EEGoSportsPlugin::EEGoSports, TMSIPlugin::TMSI, MneRtClientPlugin::Neuromag, FiffSimulatorPlugin::FiffSimulator, and ECGSimulatorPlugin::ECGSimulator.

virtual bool MNEX::ISensor::start ( )
pure virtual

Starts the ISensor. Pure virtual method inherited by IModule.

Returns
true if success, false otherwise

Implements MNEX::IPlugin.

Implemented in BabyMEGPlugin::BabyMEG, TMSIPlugin::TMSI, EEGoSportsPlugin::EEGoSports, MneRtClientPlugin::Neuromag, FiffSimulatorPlugin::FiffSimulator, ECGSimulatorPlugin::ECGSimulator, and FiffSimulatorPlugin::FiffSimulator.

virtual bool MNEX::ISensor::stop ( )
pure virtual
virtual void MNEX::ISensor::unload ( )
pure virtual

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

Implements MNEX::IPlugin.

Implemented in BabyMEGPlugin::BabyMEG, TMSIPlugin::TMSI, EEGoSportsPlugin::EEGoSports, MneRtClientPlugin::Neuromag, FiffSimulatorPlugin::FiffSimulator, and ECGSimulatorPlugin::ECGSimulator.


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