MNE-CPP  beta 1.0
Classes | Signals | Public Member Functions | Protected Member Functions | Friends | List of all members
FiffSimulatorPlugin::FiffSimulator Class Reference

The FiffSimulator class provides a Fiff data simulator. More...

#include <fiffsimulator.h>

Inheritance diagram for FiffSimulatorPlugin::FiffSimulator:
MNEX::ISensor RTSERVER::IConnector MNEX::IPlugin

Classes

struct  Commands
 

Signals

void cmdConnectionChanged (bool p_bStatus)
 
void fiffInfoAvailable ()
 
- Signals inherited from RTSERVER::IConnector
void remitMeasInfo (qint32, FIFFLIB::FiffInfo)
 
void remitRawBuffer (QSharedPointer< Eigen::MatrixXf >)
 

Public Member Functions

 FiffSimulator ()
 
virtual ~FiffSimulator ()
 
virtual void connectCommandManager ()
 
virtual ConnectorID getConnectorID () const
 
virtual const char * getName () const
 
virtual void info (qint32 ID)
 
virtual bool start ()
 
virtual bool stop ()
 
 FiffSimulator ()
 
virtual ~FiffSimulator ()
 
void clear ()
 
virtual QSharedPointer< IPluginclone () const
 
virtual void init ()
 
virtual void unload ()
 
virtual bool start ()
 
virtual bool stop ()
 
virtual IPlugin::PluginType getType () const
 
virtual QString getName () const
 
virtual QWidget * setupWidget ()
 
void changeConnector (qint32 p_iNewConnectorId)
 
void connectCmdClient ()
 
void disconnectCmdClient ()
 
void requestInfo ()
 
- Public Member Functions inherited from MNEX::ISensor
virtual ~ISensor ()
 
virtual bool multiInstanceAllowed () const
 
- Public Member Functions inherited from MNEX::IPlugin
virtual ~IPlugin ()
 
QList< QAction * > getPluginActions ()
 
InputConnectorListgetInputConnectors ()
 
OutputConnectorListgetOutputConnectors ()
 
- Public Member Functions inherited from RTSERVER::IConnector
virtual ~IConnector ()
 
CommandManagergetCommandManager ()
 
bool isActive () const
 
void setMetaData (QJsonObject &p_MetaData)
 
void setStatus (bool status)
 

Protected Member Functions

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

Friends

class FiffSimulatorSetupWidget
 

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
 
- Protected Attributes inherited from RTSERVER::IConnector
QJsonObject m_qJsonObjectMetaData
 
CommandManager m_commandManager
 

Detailed Description

The FiffSimulator class provides a Fiff data simulator.

The FiffSimulator class provides a RT server connection.

DECLARE CLASS FiffSimulator

Definition at line 97 of file fiffsimulator.h.

Constructor & Destructor Documentation

FiffSimulator::FiffSimulator ( )

Constructs a FiffSimulator.

Definition at line 102 of file fiffsimulator.cpp.

FiffSimulator::~FiffSimulator ( )
virtual

Destroys the FiffSimulator.

Definition at line 118 of file fiffsimulator.cpp.

FiffSimulatorPlugin::FiffSimulator::FiffSimulator ( )

Constructs a FiffSimulator.

virtual FiffSimulatorPlugin::FiffSimulator::~FiffSimulator ( )
virtual

Destroys the FiffSimulator.

Member Function Documentation

void FiffSimulator::changeConnector ( qint32  p_iNewConnectorId)

Change connector

Parameters
[in]p_iNewConnectorIdnew connector ID

Definition at line 155 of file fiffsimulator.cpp.

void FiffSimulator::clear ( )

Clears the rt server

Definition at line 195 of file fiffsimulator.cpp.

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

Clone the plugin

Implements MNEX::ISensor.

Definition at line 102 of file fiffsimulator.cpp.

void FiffSimulatorPlugin::FiffSimulator::cmdConnectionChanged ( bool  p_bStatus)
signal

Emitted when command clients connection status changed

Parameters
[in]p_bStatusconnection status
void FiffSimulator::connectCmdClient ( )

Connects the cmd client.

Definition at line 205 of file fiffsimulator.cpp.

void FiffSimulator::connectCommandManager ( )
virtual

Connects the command manager to the available slots.

Implements RTSERVER::IConnector.

Definition at line 284 of file fiffsimulator.cpp.

void FiffSimulator::disconnectCmdClient ( )

Disconnects the cmd client.

Definition at line 262 of file fiffsimulator.cpp.

void FiffSimulatorPlugin::FiffSimulator::fiffInfoAvailable ( )
signal

Emitted when fiffInfo is available

ConnectorID FiffSimulator::getConnectorID ( ) const
virtual

Returns the unique connector id Pure virtual method.

Returns
the connector ID.

Implements RTSERVER::IConnector.

Definition at line 297 of file fiffsimulator.cpp.

QString FiffSimulator::getName ( ) const
virtual

Returns the plugin name. Pure virtual method.

Returns
the name of plugin.

Implements RTSERVER::IConnector.

Definition at line 305 of file fiffsimulator.cpp.

virtual QString FiffSimulatorPlugin::FiffSimulator::getName ( ) const
virtual

Returns the plugin name. Pure virtual method.

Returns
the name of plugin.

Implements RTSERVER::IConnector.

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

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

Returns
type of the ISensor

Implements MNEX::ISensor.

Definition at line 366 of file fiffsimulator.cpp.

void FiffSimulator::info ( qint32  ID)
virtual

Request FiffInfo to be released.

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

Implements RTSERVER::IConnector.

Definition at line 383 of file fiffsimulator.cpp.

virtual void FiffSimulatorPlugin::FiffSimulator::init ( )
virtual

Initialise the FiffSimulator.

Implements MNEX::ISensor.

void FiffSimulator::requestInfo ( )

Request FiffInfo using cmd client and producer (data client)

Definition at line 278 of file fiffsimulator.cpp.

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

Definition at line 513 of file fiffsimulator.cpp.

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

QWidget * FiffSimulator::setupWidget ( )
virtual

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

Returns
the setup widget.

Implements MNEX::ISensor.

Definition at line 382 of file fiffsimulator.cpp.

bool FiffSimulator::start ( )
virtual

Starts the IConnector. Pure virtual method.

Returns
true if successful, false otherwise

Implements RTSERVER::IConnector.

Definition at line 356 of file fiffsimulator.cpp.

virtual bool FiffSimulatorPlugin::FiffSimulator::start ( )
virtual

Starts the IConnector. Pure virtual method.

Returns
true if successful, false otherwise

Implements RTSERVER::IConnector.

bool FiffSimulator::stop ( )
virtual

Stops the IPlugin. Pure virtual method.

Returns
true if success, false otherwise

Implements RTSERVER::IConnector.

Definition at line 371 of file fiffsimulator.cpp.

virtual bool FiffSimulatorPlugin::FiffSimulator::stop ( )
virtual

Stops the IPlugin. Pure virtual method.

Returns
true if success, false otherwise

Implements RTSERVER::IConnector.

void FiffSimulator::unload ( )
virtual

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

Implements MNEX::ISensor.

Definition at line 130 of file fiffsimulator.cpp.


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