COMMUNICATIONLIB::RtDataClient Class Reference

Real-time data client. More...

#include <rtdataclient.h>

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

Public Member Functions
	RtDataClient (QObject *parent=Q_NULLPTR)
virtual void	disconnectFromHost ()
qint32	getClientId ()
FIFFLIB::FiffInfo::SPtr	readInfo ()
MetaData	readMetadata ()
void	readRawBuffer (qint32 p_nChannels, Eigen::MatrixXf &data, FIFFLIB::fiff_int_t &kind)
void	setClientAlias (const QString &p_sAlias)

Detailed Description

Real-time data client.

The real-time data client class provides an interface to communicate with the data port 4218 of a running mne_rt_server.

Definition at line 88 of file rtdataclient.h.

Inheritance diagram for COMMUNICATIONLIB::RtDataClient:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for RtDataClient.

Definition at line 94 of file rtdataclient.h.

SPtr

typedef QSharedPointer<RtDataClient> COMMUNICATIONLIB::RtDataClient::SPtr

Shared pointer type for RtDataClient.

Definition at line 93 of file rtdataclient.h.

Constructor & Destructor Documentation

RtDataClient()

RtDataClient::RtDataClient ( QObject *  parent = Q_NULLPTR )

explicit

Creates the real-time data client.

Parameters

[in]

parent

Parent QObject (optional).

Definition at line 56 of file rtdataclient.cpp.

Member Function Documentation

disconnectFromHost()

void RtDataClient::disconnectFromHost ( )

virtual

Attempts to close the socket. If there is pending data waiting to be written, QAbstractSocket will enter ClosingState and wait until all data has been written. Eventually, it will enter UnconnectedState and emit the disconnected() signal.

Definition at line 65 of file rtdataclient.cpp.

getClientId()

qint32 RtDataClient::getClientId

(

)

Requests the ID at mne_rt_server and returns it

Returns

the requested id.

Definition at line 73 of file rtdataclient.cpp.

readInfo()

FiffInfo::SPtr RtDataClient::readInfo

(

)

Reads fiff measurement information of a data the connection

Returns

the read fiff measurement information.

Definition at line 96 of file rtdataclient.cpp.

readMetadata()

MetaData RtDataClient::readMetadata

(

)

Reads fiff metaata class from data connection

Returns

returns metadata class (FiffInfo and FiffDigitizerData)

Definition at line 369 of file rtdataclient.cpp.

readRawBuffer()

void RtDataClient::readRawBuffer	(	qint32	p_nChannels,
		Eigen::MatrixXf &	data,
		FIFFLIB::fiff_int_t &	kind
	)

Reads fiff measurement information of a data the connection

Parameters

[in]	p_nChannels	Number of channels to reshape the received data.
[out]	data	The read data - ToDo change this to raw buffer data object.
[out]	kind	Data kind.

Definition at line 656 of file rtdataclient.cpp.

setClientAlias()

void RtDataClient::setClientAlias

(

const QString &

p_sAlias

)

Sets the alias of the data client

Parameters

[in]

p_sAlias

The alias of the data client.

Definition at line 681 of file rtdataclient.cpp.

---

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

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