MNE-CPP  beta 1.0
Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RTSERVER::IConnector Class Referenceabstract

The IConnector class is the interface class of all plugins. More...

#include <IConnector.h>

Inheritance diagram for RTSERVER::IConnector:
BabyMEGPlugin::BabyMEG FiffSimulatorPlugin::FiffSimulator NeuromagPlugin::Neuromag

Signals

void remitMeasInfo (qint32, FIFFLIB::FiffInfo)
 
void remitRawBuffer (QSharedPointer< Eigen::MatrixXf >)
 

Public Member Functions

virtual ~IConnector ()
 
CommandManagergetCommandManager ()
 
virtual void connectCommandManager ()=0
 
virtual ConnectorID getConnectorID () const =0
 
virtual const char * getName () const =0
 
bool isActive () const
 
virtual bool start ()=0
 
virtual bool stop ()=0
 
void setMetaData (QJsonObject &p_MetaData)
 
void setStatus (bool status)
 
virtual void info (qint32 ID)=0
 

Protected Member Functions

virtual void run ()=0
 

Protected Attributes

QJsonObject m_qJsonObjectMetaData
 
CommandManager m_commandManager
 

Detailed Description

The IConnector class is the interface class of all plugins.

The IConnector class is the interface class for all connectors.

Definition at line 119 of file IConnector.h.

Constructor & Destructor Documentation

virtual RTSERVER::IConnector::~IConnector ( )
inlinevirtual

Destroys the IConnector.

Definition at line 127 of file IConnector.h.

Member Function Documentation

virtual void RTSERVER::IConnector::connectCommandManager ( )
pure virtual

Connects the command manager to the available slots.

Implemented in FiffSimulatorPlugin::FiffSimulator, and NeuromagPlugin::Neuromag.

CommandManager & RTSERVER::IConnector::getCommandManager ( )
inline

Returns the CommandManager

Returns
the CommandManager.

Definition at line 239 of file IConnector.h.

virtual ConnectorID RTSERVER::IConnector::getConnectorID ( ) const
pure virtual

Returns the unique connector id Pure virtual method.

Returns
the connector ID.

Implemented in FiffSimulatorPlugin::FiffSimulator, and NeuromagPlugin::Neuromag.

virtual const char* RTSERVER::IConnector::getName ( ) const
pure virtual

Returns the plugin name. Pure virtual method.

Returns
the name of plugin.

Implemented in BabyMEGPlugin::BabyMEG, FiffSimulatorPlugin::FiffSimulator, FiffSimulatorPlugin::FiffSimulator, and NeuromagPlugin::Neuromag.

virtual void RTSERVER::IConnector::info ( qint32  ID)
pure virtual

Request FiffInfo to be released.

Parameters
[in]IDID of the data client to send to. ToDo Remove this - do this processing somewhere else

Implemented in FiffSimulatorPlugin::FiffSimulator, and NeuromagPlugin::Neuromag.

bool RTSERVER::IConnector::isActive ( ) const
inline

Returns the activation status of the plugin.

Returns
true if plugin is activated.

Definition at line 247 of file IConnector.h.

virtual void RTSERVER::IConnector::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

Implemented in BabyMEGPlugin::BabyMEG, FiffSimulatorPlugin::FiffSimulator, NeuromagPlugin::Neuromag, FiffSimulatorPlugin::FiffSimulator, and BabyMEGPlugin::BabyMEG.

void RTSERVER::IConnector::setMetaData ( QJsonObject &  p_MetaData)
inline

Sets itsmeta data of the plugin after it was laoded by the pluginmanager.

Parameters
[in]statusthe new activation status of the plugin.

Definition at line 255 of file IConnector.h.

void RTSERVER::IConnector::setStatus ( bool  status)
inline

Sets the activation status of the plugin.

Parameters
[in]statusthe new activation status of the plugin.

Definition at line 263 of file IConnector.h.

virtual bool RTSERVER::IConnector::start ( )
pure virtual

Starts the IConnector. Pure virtual method.

Returns
true if successful, false otherwise

Implemented in BabyMEGPlugin::BabyMEG, FiffSimulatorPlugin::FiffSimulator, FiffSimulatorPlugin::FiffSimulator, and NeuromagPlugin::Neuromag.

virtual bool RTSERVER::IConnector::stop ( )
pure virtual

Stops the IPlugin. Pure virtual method.

Returns
true if success, false otherwise

Implemented in BabyMEGPlugin::BabyMEG, FiffSimulatorPlugin::FiffSimulator, FiffSimulatorPlugin::FiffSimulator, and NeuromagPlugin::Neuromag.

Member Data Documentation

CommandManager RTSERVER::IConnector::m_commandManager
protected

The CommandManager of the connector.

Definition at line 228 of file IConnector.h.

QJsonObject RTSERVER::IConnector::m_qJsonObjectMetaData
protected

The meta data of the plugin defined in Q_PLUGIN_METADATA and the corresponding json file.

Definition at line 226 of file IConnector.h.


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