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

Real-time data client. More...

#include <rtdataclient.h>

Inheritance diagram for RTCLIENTLIB::RtDataClient:

Public Types

typedef QSharedPointer< RtDataClientSPtr
 
typedef QSharedPointer< const RtDataClientConstSPtr
 

Public Member Functions

 RtDataClient (QObject *parent=0)
 
void connectToHost (const QString &p_sRtServerHostName)
 
virtual void disconnectFromHost ()
 
qint32 getClientId ()
 
FiffInfo::SPtr readInfo ()
 
void readRawBuffer (qint32 p_nChannels, MatrixXf &data, 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 92 of file rtdataclient.h.

Member Typedef Documentation

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

Const shared pointer type for RtDataClient.

Definition at line 97 of file rtdataclient.h.

Shared pointer type for RtDataClient.

Definition at line 96 of file rtdataclient.h.

Constructor & Destructor Documentation

RtDataClient::RtDataClient ( QObject *  parent = 0)
explicit

Creates the real-time data client.

Parameters
[in]parentParent QObject (optional)

Definition at line 59 of file rtdataclient.cpp.

Member Function Documentation

void RtDataClient::connectToHost ( const QString &  p_sRtServerHostName)

Connect to a mne_rt_server using port 4218

Parameters
[in]p_sRtServerHostNameThe IP address of the mne_rt_server

Definition at line 69 of file rtdataclient.cpp.

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 77 of file rtdataclient.cpp.

qint32 RtDataClient::getClientId ( )

Requests the ID at mne_rt_server and returns it

Returns
the requested id

Definition at line 86 of file rtdataclient.cpp.

FiffInfo::SPtr RtDataClient::readInfo ( )

Reads fiff measurement information of a data the connection

Returns
the read fiff measurement information

Definition at line 111 of file rtdataclient.cpp.

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

Reads fiff measurement information of a data the connection

Parameters
[in]p_nChannelsNumber of channels to reshape the received data
[out]dataThe read data - ToDo change this to raw buffer data object
[out]kindData kind

Definition at line 330 of file rtdataclient.cpp.

void RtDataClient::setClientAlias ( const QString &  p_sAlias)

Sets the alias of the data client

Parameters
[in]p_sAliasThe alias of the data client

Definition at line 356 of file rtdataclient.cpp.


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