MNE-CPP  beta 1.0
Signals | Public Member Functions | Protected Member Functions | List of all members
NoiseEstimatePlugin::NoiseEstimate Class Reference

The NoiseEstimate class provides a NoiseEstimate algorithm structure. More...

#include <noiseestimate.h>

Inheritance diagram for NoiseEstimatePlugin::NoiseEstimate:
MNEX::IAlgorithm MNEX::IPlugin

Signals

void fiffInfoAvailable ()
 
void SetNoisePara (qint32 nFFT, int fs)
 

Public Member Functions

 NoiseEstimate ()
 
 ~NoiseEstimate ()
 
virtual void init ()
 
virtual void unload ()
 
virtual QSharedPointer< IPluginclone () const
 
virtual bool start ()
 
virtual bool stop ()
 
virtual IPlugin::PluginType getType () const
 
virtual QString getName () const
 
virtual QWidget * setupWidget ()
 
void update (XMEASLIB::NewMeasurement::SPtr pMeasurement)
 
void appendNoiseSpectrum (Eigen::MatrixXd)
 
- Public Member Functions inherited from MNEX::IAlgorithm
virtual ~IAlgorithm ()
 
virtual bool multiInstanceAllowed () const
 
- Public Member Functions inherited from MNEX::IPlugin
virtual ~IPlugin ()
 
QList< QAction * > getPluginActions ()
 
InputConnectorListgetInputConnectors ()
 
OutputConnectorListgetOutputConnectors ()
 

Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from MNEX::IAlgorithm
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
 
- Protected Attributes inherited from MNEX::IPlugin
InputConnectorList m_inputConnectors
 
OutputConnectorList m_outputConnectors
 

Detailed Description

The NoiseEstimate class provides a NoiseEstimate algorithm structure.

DECLARE CLASS RTHPI

Definition at line 111 of file noiseestimate.h.

Constructor & Destructor Documentation

NoiseEstimate::NoiseEstimate ( )

Constructs a RtHpi.

Definition at line 68 of file noiseestimate.cpp.

NoiseEstimate::~NoiseEstimate ( )

Destroys the RtHpi.

Definition at line 84 of file noiseestimate.cpp.

Member Function Documentation

void NoiseEstimate::appendNoiseSpectrum ( Eigen::MatrixXd  )

Add the spectrum result into a list

Definition at line 282 of file noiseestimate.cpp.

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

Clone the plugin

Implements MNEX::IAlgorithm.

Definition at line 93 of file noiseestimate.cpp.

void NoiseEstimatePlugin::NoiseEstimate::fiffInfoAvailable ( )
signal

Emitted when fiffInfo is available

QString NoiseEstimate::getName ( ) const
virtual

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

Returns
the name of the IAlgorithm.

Implements MNEX::IAlgorithm.

Definition at line 224 of file noiseestimate.cpp.

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

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

Returns
type of the IAlgorithm

Implements MNEX::IAlgorithm.

Definition at line 216 of file noiseestimate.cpp.

void NoiseEstimate::init ( )
virtual

Initialise input and output connectors.

Implements MNEX::IAlgorithm.

Definition at line 105 of file noiseestimate.cpp.

void NoiseEstimate::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 MNEX::IAlgorithm.

Definition at line 294 of file noiseestimate.cpp.

void NoiseEstimatePlugin::NoiseEstimate::SetNoisePara ( qint32  nFFT,
int  fs 
)
signal

Emitted Noise parameters

QWidget * NoiseEstimate::setupWidget ( )
virtual

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

Returns
the setup widget.

Implements MNEX::IAlgorithm.

Definition at line 232 of file noiseestimate.cpp.

bool NoiseEstimate::start ( )
virtual

Starts the IAlgorithm. Pure virtual method inherited by IPlugin.

Returns
true if success, false otherwise

Implements MNEX::IAlgorithm.

Definition at line 165 of file noiseestimate.cpp.

bool NoiseEstimate::stop ( )
virtual

Stops the IAlgorithm. Pure virtual method inherited by IPlugin.

Returns
true if success, false otherwise

Implements MNEX::IAlgorithm.

Definition at line 183 of file noiseestimate.cpp.

void NoiseEstimate::unload ( )
virtual

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

Implements MNEX::IAlgorithm.

Definition at line 137 of file noiseestimate.cpp.


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