COMMUNICATIONLIB::RtClient Class Reference

Real-time client. More...

#include <rtclient.h>

Public Types
typedef QSharedPointer< RtClient >	SPtr
typedef QSharedPointer< const RtClient >	ConstSPtr

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 ()
FIFFLIB::FiffInfo::SPtr &	getFiffInfo ()
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 80 of file rtclient.h.

Inheritance diagram for COMMUNICATIONLIB::RtClient:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for MNERtClient.

Definition at line 86 of file rtclient.h.

SPtr

typedef QSharedPointer<RtClient> COMMUNICATIONLIB::RtClient::SPtr

Shared pointer type for MNERtClient.

Definition at line 85 of file rtclient.h.

Constructor & Destructor Documentation

RtClient()

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

explicit

Creates the real-time client.

Parameters

[in]	p_sRtServerHostname	The IP address of the mne_rt_server.
[in]	p_sClientAlias	The client alias of the data client.
[in]	parent	Parent QObject (optional).

Definition at line 57 of file rtclient.cpp.

~RtClient()

RtClient::~RtClient

(

)

Destroys the real time client.

Definition at line 70 of file rtclient.cpp.

Member Function Documentation

connectionChanged

void COMMUNICATIONLIB::RtClient::connectionChanged ( bool  p_bStatus )

signal

Emitted when connection status changed

Parameters

[in]

p_bStatus

connection status.

getConnectionStatus()

bool RtClient::getConnectionStatus

(

)

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

Returns

true if started, false otherwise.

Definition at line 77 of file rtclient.cpp.

getFiffInfo()

FIFFLIB::FiffInfo::SPtr & COMMUNICATIONLIB::RtClient::getFiffInfo ( )

inline

Request Fiff Info

Definition at line 166 of file rtclient.h.

rawBufferReceived

void COMMUNICATIONLIB::RtClient::rawBufferReceived ( Eigen::MatrixXf  p_rawBuffer )

signal

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

Parameters

[in]

p_rawBuffer

the received raw buffer.

run()

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 94 of file rtclient.cpp.

stop()

bool RtClient::stop ( )

virtual

Stops the RtClient by stopping the producer's thread.

Returns

true if succeeded, false otherwise.

Definition at line 84 of file rtclient.cpp.

---

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

• src/libraries/communication/rtClient/rtclient.h
• src/libraries/communication/rtClient/rtclient.cpp