MNE-CPP  beta 1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
MNEX::PluginInputData< T > Class Template Reference
Inheritance diagram for MNEX::PluginInputData< T >:
MNEX::PluginInputConnector MNEX::PluginConnector

Public Types

typedef void(* callback_function) (QSharedPointer< T >)
 
typedef QSharedPointer< PluginInputDataSPtr
 
typedef QSharedPointer< const PluginInputDataConstSPtr
 
- Public Types inherited from MNEX::PluginInputConnector
typedef QSharedPointer< PluginInputConnectorSPtr
 
typedef QSharedPointer< const PluginInputConnectorConstSPtr
 
- Public Types inherited from MNEX::PluginConnector
typedef QSharedPointer< PluginConnectorSPtr
 
typedef QSharedPointer< const PluginConnectorConstSPtr
 

Public Member Functions

 PluginInputData (IPlugin *parent, const QString &name, const QString &descr)
 
virtual ~PluginInputData ()
 
void setCallbackMethod (callback_function pFunc)
 
- Public Member Functions inherited from MNEX::PluginInputConnector
 PluginInputConnector (IPlugin *parent, const QString &name, const QString &descr)
 
virtual ~PluginInputConnector ()
 
virtual bool isInputConnector () const
 
virtual bool isOutputConnector () const
 
- Public Member Functions inherited from MNEX::PluginConnector
 PluginConnector (IPlugin *parent, const QString &name, const QString &descr)
 
virtual ~PluginConnector ()
 
QString getName () const
 

Static Public Member Functions

static QSharedPointer< PluginInputData< T > > create (IPlugin *parent, const QString &name, const QString &descr)
 

Protected Member Functions

void notifyCallbackFunction (XMEASLIB::NewMeasurement::SPtr pMeasurement)
 

Additional Inherited Members

- Public Slots inherited from MNEX::PluginInputConnector
void update (XMEASLIB::NewMeasurement::SPtr pMeasurement)
 
- Signals inherited from MNEX::PluginInputConnector
void notify (XMEASLIB::NewMeasurement::SPtr pMeasurement)
 
- Protected Attributes inherited from MNEX::PluginConnector
IPluginm_pPlugin
 
QSet< PluginConnector::SPtrm_setConnections
 

Detailed Description

template<class T>
class MNEX::PluginInputData< T >

Definition at line 60 of file plugininputdata.h.

Member Typedef Documentation

template<class T>
typedef void(* MNEX::PluginInputData< T >::callback_function) (QSharedPointer< T >)

Callback function type.

Definition at line 63 of file plugininputdata.h.

template<class T>
typedef QSharedPointer<const PluginInputData> MNEX::PluginInputData< T >::ConstSPtr

Const shared pointer type for PluginInputData.

Definition at line 66 of file plugininputdata.h.

template<class T>
typedef QSharedPointer<PluginInputData> MNEX::PluginInputData< T >::SPtr

Shared pointer type for PluginInputData.

Definition at line 65 of file plugininputdata.h.

Constructor & Destructor Documentation

template<class T >
MNEX::PluginInputData< T >::PluginInputData ( IPlugin parent,
const QString &  name,
const QString &  descr 
)

Constructs a PluginInputData with the given parent.

Parameters
[in]parentpointer to parent plugin
[in]nameconnection name
[in]descrconnection description

Definition at line 67 of file plugininputdata.cpp.

template<class T>
virtual MNEX::PluginInputData< T >::~PluginInputData ( )
inlinevirtual

Destructor

Definition at line 83 of file plugininputdata.h.

Member Function Documentation

template<class T >
QSharedPointer< PluginInputData< T > > MNEX::PluginInputData< T >::create ( IPlugin parent,
const QString &  name,
const QString &  descr 
)
inlinestatic

Creates PluginInputData with the given parent.

Parameters
[in]parentpointer to parent plugin
[in]nameconnection name
[in]descrconnection description
Returns
the created PluginInputData

Definition at line 126 of file plugininputdata.h.

template<class T >
void MNEX::PluginInputData< T >::notifyCallbackFunction ( XMEASLIB::NewMeasurement::SPtr  pMeasurement)
protected

SLOT to notify the registered calback fucntion.

Parameters
[in]pMeasurementthe measurement data to downcast.

Definition at line 87 of file plugininputdata.cpp.

template<class T >
void MNEX::PluginInputData< T >::setCallbackMethod ( callback_function  pFunc)

Convinience function - this can be used to register a function which should be called when new data are available. The signal void notify(XMEASLIB::NewMeasurement::SPtr) can be used instead of registering a function.

Parameters
[in]pFunccallback function to register

Definition at line 77 of file plugininputdata.cpp.


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