MNE-CPP  beta 1.0
Public Types | Signals | Public Member Functions | Protected Member Functions | List of all members
RTCLIENTLIB::RtClient Class Reference

Real-time client. More...

#include <rtclient.h>

Inheritance diagram for RTCLIENTLIB::RtClient:

Public Types

typedef QSharedPointer< RtClientSPtr
 
typedef QSharedPointer< const RtClientConstSPtr
 

Signals

void rawBufferReceived (Eigen::MatrixXf p_rawBuffer)
 
void connectionChanged (bool p_bStatus)
 

Public Member Functions

 RtClient (QString p_sRtServerHostname, QString p_sClientAlias="rtclient", QObject *parent=0)
 
 ~RtClient ()
 
FiffInfo::SPtrgetFiffInfo ()
 
bool getConnectionStatus ()
 
virtual bool stop ()
 

Protected Member Functions

virtual void run ()
 

Detailed Description

Real-time client.

The real-time client class provides an interface to communicate with a running mne_rt_server.

Definition at line 105 of file rtclient.h.

Member Typedef Documentation

typedef QSharedPointer<const RtClient> RTCLIENTLIB::RtClient::ConstSPtr

Const shared pointer type for MNERtClient.

Definition at line 110 of file rtclient.h.

typedef QSharedPointer<RtClient> RTCLIENTLIB::RtClient::SPtr

Shared pointer type for MNERtClient.

Definition at line 109 of file rtclient.h.

Constructor & Destructor Documentation

RtClient::RtClient ( QString  p_sRtServerHostname,
QString  p_sClientAlias = "rtclient",
QObject *  parent = 0 
)
explicit

Creates the real-time client.

Parameters
[in]p_sRtServerHostnameThe IP address of the mne_rt_server
[in]p_sClientAliasThe client alias of the data client.
[in]parentParent QObject (optional)

Definition at line 61 of file rtclient.cpp.

RtClient::~RtClient ( )

Destroys the real time client.

Definition at line 74 of file rtclient.cpp.

Member Function Documentation

void RTCLIENTLIB::RtClient::connectionChanged ( bool  p_bStatus)
signal

Emitted when connection status changed

Parameters
[in]p_bStatusconnection status
bool RtClient::getConnectionStatus ( )

Rt Server status, returns true when rt server is started.

Returns
true if started, false otherwise

Definition at line 82 of file rtclient.cpp.

FiffInfo::SPtr & RTCLIENTLIB::RtClient::getFiffInfo ( )
inline

Request Fiff Info

Definition at line 192 of file rtclient.h.

void RTCLIENTLIB::RtClient::rawBufferReceived ( Eigen::MatrixXf  p_rawBuffer)
signal

Emits a received raw buffer - ToDo change the emits to fiff raw data.

Parameters
[in]p_rawBufferthe received raw buffer
void RtClient::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.

Definition at line 101 of file rtclient.cpp.

bool RtClient::stop ( )
virtual

Stops the RtClient by stopping the producer's thread.

Returns
true if succeeded, false otherwise

Definition at line 90 of file rtclient.cpp.


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