Superclass for OpenIGTLink clients. More...

#include <mitkIGTLClient.h>

Inheritance diagram for mitk::IGTLClient:

Collaboration diagram for mitk::IGTLClient:

Public Member Functions
	mitkClassMacro (IGTLClient, IGTLDevice)

	mitkNewMacro1Param (Self, bool)

Pointer	Clone () const

bool	OpenConnection () override
	Establishes the connection between this client and the IGTL server. More...

unsigned int	GetNumberOfConnections () override
	Returns the number of connections of this device. More...

Public Member Functions inherited from mitk::IGTLDevice
	mitkClassMacroItkParent (IGTLDevice, itk::Object)

	IGTLDevice (bool ReadFully)

virtual bool	CloseConnection ()
	Closes the connection to the device. More...

virtual bool	StopCommunication ()
	Stops the communication between the two devices. More...

bool	StartCommunication ()
	Starts the communication between the two devices. More...

void	RunCommunication (void(IGTLDevice::ComFunction)(void), itk::FastMutexLock mutex)
	Continuously calls the given function. More...

void	SendMessage (mitk::IGTLMessage::Pointer msg)
	Adds the given message to the sending queue. More...

IGTLDeviceState	GetState () const
	Returns current object state (Setup, Ready or Running) More...

igtl::MessageBase::Pointer	GetNextCommand ()
	Returns the oldest message in the command queue. More...

igtl::ImageMessage::Pointer	GetNextImage2dMessage ()
	Returns the oldest message in the receive queue. More...

igtl::ImageMessage::Pointer	GetNextImage3dMessage ()

igtl::TransformMessage::Pointer	GetNextTransformMessage ()

igtl::TrackingDataMessage::Pointer	GetNextTrackingDataMessage ()

igtl::StringMessage::Pointer	GetNextStringMessage ()

igtl::MessageBase::Pointer	GetNextMiscMessage ()

virtual void	SetPortNumber (int _arg)
	Sets the port number of the device. More...

virtual int	GetPortNumber ()
	Returns the port number of the device. More...

virtual void	SetHostname (std::string _arg)
	Sets the ip/hostname of the device. More...

virtual std::string	GetHostname ()
	Returns the ip/hostname of the device. More...

virtual std::string	GetName () const
	Returns the name of this device. More...

virtual void	SetName (std::string _arg)
	Sets the name of this device. More...

virtual void	SetReadFully (bool _arg)
	Advises this IGTL Device to always block until the whole message is read. More...

virtual mitk::IGTLMessageQueue::Pointer	GetMessageQueue () const
	Returns a const reference to the receive queue. More...

virtual mitk::IGTLMessageFactory::Pointer	GetMessageFactory ()
	Returns the message factory. More...

virtual bool	TestConnection ()
	TestConnection() tries to connect to a IGTL device on the current ip and port. More...

bool	SendRTSMessage (const char *type)
	Send RTS message of given type. More...

void	EnableNoBufferingMode (mitk::IGTLMessageQueue::Pointer queue, bool enable=true)
	Sets the buffering mode of the given queue. More...

void	EnableNoBufferingMode (bool enable=true)

virtual bool	GetLogMessages ()

virtual void	SetLogMessages (bool _arg)

Protected Member Functions
	IGTLClient (bool ReadFully)

	~IGTLClient () override

void	Receive () override
	Call this method to receive a message. More...

void	Send () override
	Call this method to send a message. More...

void	StopCommunicationWithSocket (igtl::Socket *) override
	Stops the communication with the given socket. More...

Protected Member Functions inherited from mitk::IGTLDevice
unsigned int	SendMessagePrivate (mitk::IGTLMessage::Pointer msg, igtl::Socket::Pointer socket)
	Sends a message. More...

unsigned int	ReceivePrivate (igtl::Socket *device)
	Call this method to receive a message from the given device. More...

virtual void	Connect ()
	Call this method to check for other devices that want to connect to this one. More...

void	SetState (IGTLDeviceState state)
	change object state More...

	IGTLDevice ()

	~IGTLDevice () override

Additional Inherited Members
Public Types inherited from mitk::IGTLDevice
enum	IGTLDeviceState { Setup, Ready, Running }
	Type for state variable. The IGTLDevice is always in one of these states. More...

Static Public Member Functions inherited from mitk::IGTLDevice
static ITK_THREAD_RETURN_TYPE	ThreadStartSending (void *data)
	static start method for the sending thread. More...

static ITK_THREAD_RETURN_TYPE	ThreadStartReceiving (void *data)
	static start method for the receiving thread. More...

static ITK_THREAD_RETURN_TYPE	ThreadStartConnecting (void *data)
	static start method for the connection thread. More...

Protected Attributes inherited from mitk::IGTLDevice
IGTLDeviceState	m_State

std::string	m_Name

bool	m_StopCommunication

itk::FastMutexLock::Pointer	m_StopCommunicationMutex

itk::FastMutexLock::Pointer	m_SendingFinishedMutex

itk::FastMutexLock::Pointer	m_ReceivingFinishedMutex

itk::FastMutexLock::Pointer	m_ConnectingFinishedMutex

itk::FastMutexLock::Pointer	m_StateMutex

std::string	m_Hostname

int	m_PortNumber

igtl::Socket::Pointer	m_Socket

mitk::IGTLMessageQueue::Pointer	m_MessageQueue

mitk::IGTLMessageFactory::Pointer	m_MessageFactory

bool	m_LogMessages

Detailed Description

Superclass for OpenIGTLink clients.

Implements the IGTLDevice interface for IGTLClients. In certain points it behaves different than the IGTLServer. The client connects directly to a server (it cannot connect to two different servers). Therefore, it has to check only this one connection.

Definition at line 35 of file mitkIGTLClient.h.

Constructor & Destructor Documentation

◆ IGTLClient()

mitk::IGTLClient::IGTLClient ( bool ReadFully )

protected

Constructor

Definition at line 27 of file mitkIGTLClient.cpp.

◆ ~IGTLClient()

mitk::IGTLClient::~IGTLClient ( )

overrideprotected

Destructor

Definition at line 32 of file mitkIGTLClient.cpp.

Member Function Documentation

◆ Clone()

Pointer mitk::IGTLClient::Clone ( ) const

◆ GetNumberOfConnections()

unsigned int mitk::IGTLClient::GetNumberOfConnections ( )

overridevirtual

Returns the number of connections of this device.

A client can connect to one sever only, therefore, the number is either 0 or 1

Implements mitk::IGTLDevice.

Definition at line 117 of file mitkIGTLClient.cpp.

References mitk::IGTLDevice::m_Socket.

◆ mitkClassMacro()

mitk::IGTLClient::mitkClassMacro	(	IGTLClient	,
		IGTLDevice
	)

◆ mitkNewMacro1Param()

mitk::IGTLClient::mitkNewMacro1Param	(	Self	,
		bool
	)

◆ OpenConnection()

bool mitk::IGTLClient::OpenConnection ( )

overridevirtual

Establishes the connection between this client and the IGTL server.

Exceptions

mitk::Exception Throws an exception if the client is not in Setup mode or if it cannot connect to the defined host.

Implements mitk::IGTLDevice.

Definition at line 36 of file mitkIGTLClient.cpp.

References mitk::IGTLDevice::GetHostname(), mitk::IGTLDevice::GetPortNumber(), mitk::IGTLDevice::GetState(), mitk::IGTLDevice::m_Socket, MITK_ERROR, MITK_WARN, mitkThrowException, mitk::IGTLDevice::Ready, mitk::IGTLDevice::SetState(), and mitk::IGTLDevice::Setup.

◆ Receive()

void mitk::IGTLClient::Receive ( )

overrideprotectedvirtual

Call this method to receive a message.

The message will be saved in the receive queue. If the connection is lost it will stop the communication.

Implements mitk::IGTLDevice.

Definition at line 78 of file mitkIGTLClient.cpp.

References mitk::IGTLDevice::m_Socket, MITK_WARN, mitk::IGTLDevice::ReceivePrivate(), and StopCommunicationWithSocket().

◆ Send()

void mitk::IGTLClient::Send ( )

overrideprotectedvirtual

Call this method to send a message.

The message will be read from the queue.

Implements mitk::IGTLDevice.

Definition at line 93 of file mitkIGTLClient.cpp.

References mitk::IGTLDevice::m_MessageQueue, mitk::IGTLDevice::m_Socket, MITK_WARN, and mitk::IGTLDevice::SendMessagePrivate().

◆ StopCommunicationWithSocket()

void mitk::IGTLClient::StopCommunicationWithSocket ( igtl::Socket * )

overrideprotectedvirtual

Stops the communication with the given socket.

The client uses just one socket. Therefore, calling this function causes the stop of the communication.

Implements mitk::IGTLDevice.

Definition at line 110 of file mitkIGTLClient.cpp.

References mitk::IGTLDevice::m_StopCommunication, and mitk::IGTLDevice::m_StopCommunicationMutex.

Referenced by Receive().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IGTLClient()

◆ ~IGTLClient()

Member Function Documentation

◆ Clone()

◆ GetNumberOfConnections()

◆ mitkClassMacro()

◆ mitkNewMacro1Param()

◆ OpenConnection()

◆ Receive()

◆ Send()

◆ StopCommunicationWithSocket()