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

The IIO class provides an interface for a real-time record plugin. More...

#include <IIO.h>

Inheritance diagram for MNEX::IIO:
MNEX::IPlugin

Public Types

typedef QSharedPointer< IIOSPtr
 
typedef QSharedPointer< const IIOConstSPtr
 
- 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 ~IIO ()
 
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 QWidget * setupWidget () const =0
 
void setRTRecordDirName (const QString &dirName)
 
- Public Member Functions inherited from MNEX::IPlugin
virtual ~IPlugin ()
 
QList< QAction * > getPluginActions ()
 
virtual bool multiInstanceAllowed () const =0
 
virtual QWidget * setupWidget ()=0
 
InputConnectorListgetInputConnectors ()
 
OutputConnectorListgetOutputConnectors ()
 

Protected Types

typedef QMap< unsigned short, QFile * > t_FileMap
 

Protected Member Functions

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

Protected Attributes

QString m_RTRecordDirName
 
t_FileMap m_mapFiles
 
- Protected Attributes inherited from MNEX::IPlugin
InputConnectorList m_inputConnectors
 
OutputConnectorList m_outputConnectors
 

Detailed Description

The IIO class provides an interface for a real-time record plugin.

DECLARE CLASS IIO

Definition at line 83 of file IIO.h.

Member Typedef Documentation

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

Const shared pointer type for IIO.

Definition at line 88 of file IIO.h.

typedef QSharedPointer<IIO> MNEX::IIO::SPtr

Shared pointer type for IIO.

Definition at line 87 of file IIO.h.

typedef QMap<unsigned short, QFile*> MNEX::IIO::t_FileMap
protected

Defines a new file mapping type.

Definition at line 178 of file IIO.h.

Constructor & Destructor Documentation

virtual MNEX::IIO::~IIO ( )
inlinevirtual

Destroys the IIO.

Definition at line 94 of file IIO.h.

Member Function Documentation

virtual QSharedPointer<IPlugin> MNEX::IIO::clone ( ) const
pure virtual

Clone the plugin

Implements MNEX::IPlugin.

virtual QString MNEX::IIO::getName ( ) const
pure virtual

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

Returns
the name of the IIO.

Implements MNEX::IPlugin.

virtual PluginType MNEX::IIO::getType ( ) const
pure virtual

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

Returns
type of the IIO

Implements MNEX::IPlugin.

virtual void MNEX::IIO::init ( )
pure virtual

Initializes the plugin.

Implements MNEX::IPlugin.

virtual void MNEX::IIO::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.

void MNEX::IIO::setRTRecordDirName ( const QString &  dirName)
inline

Sets the name of the RTRecord directory.

Parameters
[in]dirNamename of the RTRecord directory

Definition at line 188 of file IIO.h.

virtual QWidget* MNEX::IIO::setupWidget ( ) const
pure virtual

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

Returns
the setup widget.
virtual bool MNEX::IIO::start ( )
pure virtual

Starts the IIO. Pure virtual method inherited by IPlugin.

Returns
true if success, false otherwise

Implements MNEX::IPlugin.

virtual bool MNEX::IIO::stop ( )
pure virtual

Stops the IIO. Pure virtual method inherited by IPlugin.

Returns
true if success, false otherwise

Implements MNEX::IPlugin.

virtual void MNEX::IIO::unload ( )
pure virtual

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

Implements MNEX::IPlugin.

Member Data Documentation

t_FileMap MNEX::IIO::m_mapFiles
protected

the file map.

Definition at line 179 of file IIO.h.

QString MNEX::IIO::m_RTRecordDirName
protected

the real-time record sub directory name.

Definition at line 177 of file IIO.h.


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