PlusIgtlClientInfo Class Reference

This class provides client information for vtkPlusOpenIGTLinkServer. More...

#include <src/PlusOpenIGTLink/PlusIgtlClientInfo.h>

Classes
struct	EncodingParameters
struct	ImageStream
struct	VideoStream

Public Member Functions
int	GetClientHeaderVersion () const
void	GetClientInfoInXmlData (std::string &strXmlData)
double	GetLastTDATASentTimeStamp () const
bool	GetTDATARequested () const
int	GetTDATAResolution () const
	PlusIgtlClientInfo ()
virtual void	PrintSelf (ostream &os, vtkIndent indent)
void	SetClientHeaderVersion (int version)
PlusStatus	SetClientInfoFromXmlData (const char *strXmlData)
PlusStatus	SetClientInfoFromXmlData (vtkXMLDataElement *xmldata)
void	SetLastTDATASentTimeStamp (double val)
void	SetTDATARequested (bool val)
void	SetTDATAResolution (int val)

Public Attributes
std::vector< std::string >	IgtlMessageTypes
std::vector< ImageStream >	ImageStreams
std::vector< std::string >	StringNames
std::vector< igsioTransformName >	TransformNames
std::vector< VideoStream >	VideoStreams

Protected Attributes
int	ClientHeaderVersion
double	LastTDATASentTimeStamp
bool	TDATARequested
int	TDATAResolution

Detailed Description

This class provides client information for vtkPlusOpenIGTLinkServer.

Definition at line 32 of file PlusIgtlClientInfo.h.

Constructor & Destructor Documentation

PlusIgtlClientInfo()

PlusIgtlClientInfo::PlusIgtlClientInfo

(

)

Definition at line 14 of file PlusIgtlClientInfo.cxx.

Member Function Documentation

GetClientHeaderVersion()

int PlusIgtlClientInfo::GetClientHeaderVersion

(

)

const

IGTL header version supported by the client

Definition at line 390 of file PlusIgtlClientInfo.cxx.

GetClientInfoInXmlData()

void PlusIgtlClientInfo::GetClientInfoInXmlData

(

std::string &

strXmlData

)

Serialize client info data to xml data and return in string

Definition at line 236 of file PlusIgtlClientInfo.cxx.

GetLastTDATASentTimeStamp()

double PlusIgtlClientInfo::GetLastTDATASentTimeStamp

(

)

const

timestamp of the last sent TDATA message.

Definition at line 426 of file PlusIgtlClientInfo.cxx.

GetTDATARequested()

bool PlusIgtlClientInfo::GetTDATARequested

(

)

const

Flag for start TDATA transmission request: true on STT, false on STP. If the start requested flag is false then don't send TDATA to the client.

Definition at line 414 of file PlusIgtlClientInfo.cxx.

GetTDATAResolution()

int PlusIgtlClientInfo::GetTDATAResolution

(

)

const

Minimum time between two TDATA frames. Use 0 for as fast as possible. If e.g. 50 ms is specified, the maximum update rate will be 20 Hz.

Definition at line 402 of file PlusIgtlClientInfo.cxx.

PrintSelf()

void PlusIgtlClientInfo::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Definition at line 308 of file PlusIgtlClientInfo.cxx.

SetClientHeaderVersion()

void PlusIgtlClientInfo::SetClientHeaderVersion

(

int

version

)

IGTL header version supported by the client

Definition at line 396 of file PlusIgtlClientInfo.cxx.

SetClientInfoFromXmlData() [1/2]

PlusStatus PlusIgtlClientInfo::SetClientInfoFromXmlData

(

const char *

strXmlData

)

De-serialize client info data from string xml data

Definition at line 24 of file PlusIgtlClientInfo.cxx.

SetClientInfoFromXmlData() [2/2]

PlusStatus PlusIgtlClientInfo::SetClientInfoFromXmlData

(

vtkXMLDataElement *

xmldata

)

De-serialize client info data from xml data

Definition at line 44 of file PlusIgtlClientInfo.cxx.

SetLastTDATASentTimeStamp()

void PlusIgtlClientInfo::SetLastTDATASentTimeStamp

(

double

val

)

timestamp of the last sent TDATA message.

Definition at line 432 of file PlusIgtlClientInfo.cxx.

SetTDATARequested()

void PlusIgtlClientInfo::SetTDATARequested

(

bool

val

)

Flag for start TDATA transmission request: true on STT, false on STP. If the start requested flag is false then don't send TDATA to the client.

Definition at line 420 of file PlusIgtlClientInfo.cxx.

SetTDATAResolution()

void PlusIgtlClientInfo::SetTDATAResolution

(

int

val

)

Minimum time between two TDATA frames. Use 0 for as fast as possible. If e.g. 50 ms is specified, the maximum update rate will be 20 Hz.

Definition at line 408 of file PlusIgtlClientInfo.cxx.

Member Data Documentation

ClientHeaderVersion

int PlusIgtlClientInfo::ClientHeaderVersion

protected

Definition at line 149 of file PlusIgtlClientInfo.h.

IgtlMessageTypes

std::vector<std::string> PlusIgtlClientInfo::IgtlMessageTypes

Message types that client expects from the server

Definition at line 134 of file PlusIgtlClientInfo.h.

ImageStreams

std::vector<ImageStream> PlusIgtlClientInfo::ImageStreams

Transform names to send with IGT IMAGE message

Definition at line 143 of file PlusIgtlClientInfo.h.

LastTDATASentTimeStamp

double PlusIgtlClientInfo::LastTDATASentTimeStamp

protected

Definition at line 151 of file PlusIgtlClientInfo.h.

StringNames

std::vector<std::string> PlusIgtlClientInfo::StringNames

String field names to send with IGT STRING message

Definition at line 140 of file PlusIgtlClientInfo.h.

TDATARequested

bool PlusIgtlClientInfo::TDATARequested

protected

Definition at line 150 of file PlusIgtlClientInfo.h.

TDATAResolution

int PlusIgtlClientInfo::TDATAResolution

protected

Definition at line 152 of file PlusIgtlClientInfo.h.

TransformNames

std::vector<igsioTransformName> PlusIgtlClientInfo::TransformNames

Transform names to send with IGT transform, position message

Definition at line 137 of file PlusIgtlClientInfo.h.

VideoStreams

std::vector<VideoStream> PlusIgtlClientInfo::VideoStreams

Transform names to send with IGT VIDEO message

Definition at line 146 of file PlusIgtlClientInfo.h.

---

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

• src/PlusOpenIGTLink/PlusIgtlClientInfo.h
• src/PlusOpenIGTLink/PlusIgtlClientInfo.cxx