PlusLib  2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPlusOpenIGTLinkDevice Class Reference
DataCollection

Common base class for OpenIGTLink-based tracking and video devices. More...

#include <src/PlusDataCollection/OpenIGTLink/vtkPlusOpenIGTLinkDevice.h>

Inheritance diagram for vtkPlusOpenIGTLinkDevice:
Inheritance graph
[legend]
Collaboration diagram for vtkPlusOpenIGTLinkDevice:
Collaboration graph
[legend]

Public Types

typedef vtkPlusDevice Superclass
 
- Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int GetIgtlMessageCrcCheckEnabled ()
 
virtual igsioTransformName GetImageMessageEmbeddedTransformName ()
 
virtual double GetReceiveTimeoutSec ()
 
virtual bool GetReconnectOnReceiveTimeout ()
 
virtual std::string GetSdkVersion ()
 
virtual double GetSendTimeoutSec ()
 
virtual int GetServerPort ()
 
virtual PlusStatus InternalConnect ()
 
virtual PlusStatus InternalDisconnect ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
virtual PlusStatus Probe ()
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *config)
 
bool SendMessage (igtl::MessageBase::Pointer packedMessage)
 
virtual void SetIgtlMessageCrcCheckEnabled (int)
 
virtual void SetImageMessageEmbeddedTransformName (igsioTransformName)
 
virtual void SetImageMessageEmbeddedTransformName (std::string)
 
virtual void SetReceiveTimeoutSec (double)
 
virtual void SetSendTimeoutSec (double)
 
virtual void SetServerPort (int)
 
 vtkGetStdStringMacro (MessageType)
 
 vtkGetStdStringMacro (ServerAddress)
 
 vtkSetStdStringMacro (MessageType)
 
 vtkSetStdStringMacro (ServerAddress)
 
virtual PlusStatus WriteConfiguration (vtkXMLDataElement *config)
 
- Public Member Functions inherited from vtkPlusDevice
PlusStatus AddFieldDataSource (vtkPlusDataSource *aSource)
 
PlusStatus AddInputChannel (vtkPlusChannel *aChannel)
 
PlusStatus AddOutputChannel (vtkPlusChannel *aChannel)
 
PlusStatus AddTool (vtkPlusDataSource *tool, bool requireUniquePortName=true)
 
PlusStatus AddVideoSource (vtkPlusDataSource *anImage)
 
void ClearAllBuffers ()
 
virtual PlusStatus Connect ()
 
virtual PlusStatus CreateDefaultOutputChannel (const char *channelId=NULL, bool addSource=true)
 
void DeepCopy (const vtkPlusDevice &device)
 
virtual PlusStatus Disconnect ()
 
virtual PlusStatus ForceUpdate ()
 
virtual double GetAcquisitionRate () const
 
virtual PlusStatus GetBufferSize (vtkPlusChannel &aChannel, int &outVal, const std::string &aSourceId=std::string(""))
 
virtual int GetConnected () const
 
virtual bool GetCorrectlyConfigured () const
 
PlusStatus GetDataSource (const char *aSourceId, vtkPlusDataSource *&aSource)
 
PlusStatus GetDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource)
 
virtual double GetDesiredTimestamp ()
 
virtual std::string GetDeviceId () const
 
PlusStatus GetFieldDataSource (const char *aSourceId, vtkPlusDataSource *&aSource) const
 
PlusStatus GetFieldDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource) const
 
DataSourceContainerConstIterator GetFieldDataSourcessIteratorBegin () const
 
DataSourceContainerConstIterator GetFieldDataSourcessIteratorEnd () const
 
PlusStatus GetFirstActiveOutputVideoSource (vtkPlusDataSource *&aVideoSource)
 
PlusStatus GetFirstActiveTool (vtkPlusDataSource *&aTool) const
 
PlusStatus GetFirstOutputChannel (vtkPlusChannel *&aChannel)
 
PlusStatus GetFirstVideoSource (vtkPlusDataSource *&anImage)
 
virtual unsigned long GetFrameNumber () const
 
virtual double GetFrameTimeStamp () const
 
virtual PlusStatus GetImage (const std::string &requestedImageId, std::string &assignedImageId, const std::string &imageReferencFrameName, vtkImageData *imageData, vtkMatrix4x4 *ijkToReferenceTransform)
 
virtual PlusStatus GetImageMetaData (igsioCommon::ImageMetaDataList &imageMetaDataItems)
 
virtual US_IMAGE_TYPE GetImageType (vtkPlusChannel &aChannel)
 
PlusStatus GetInputDevices (std::vector< vtkPlusDevice * > &outDeviceList) const
 
PlusStatus GetInputDevicesRecursive (std::vector< vtkPlusDevice * > &outDeviceList) const
 
virtual PlusStatus GetInputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const
 
virtual PlusStatus GetInputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const
 
double GetInternalUpdateRate () const
 
virtual double GetLocalTimeOffsetSec () const
 
double GetMissingInputGracePeriodSec () const
 
virtual int GetNumberOfFieldDataSources () const
 
virtual int GetNumberOfTools () const
 
virtual int GetNumberOfVideoSources () const
 
PlusStatus GetOutputChannelByName (vtkPlusChannel *&aChannel, const char *aChannelId)
 
PlusStatus GetOutputChannelByName (vtkPlusChannel *&aChannel, const std::string &aChannelId)
 
ChannelContainerConstIterator GetOutputChannelsEnd () const
 
ChannelContainerIterator GetOutputChannelsEnd ()
 
ChannelContainerConstIterator GetOutputChannelsStart () const
 
ChannelContainerIterator GetOutputChannelsStart ()
 
virtual PlusStatus GetOutputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const
 
virtual PlusStatus GetOutputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const
 
virtual std::string GetParameter (const std::string &key) const
 
virtual PlusStatus GetParameter (const std::string &key, std::string &outValue) const
 
virtual igsioCommon::VTKScalarPixelType GetPixelType (vtkPlusChannel &aChannel)
 
virtual double GetStartTime ()
 
virtual double GetTimestampClosestToDesired ()
 
PlusStatus GetTool (const char *aToolSourceId, vtkPlusDataSource *&aTool) const
 
PlusStatus GetTool (const std::string &aToolSourceId, vtkPlusDataSource *&aTool) const
 
PlusStatus GetToolByPortName (const char *aPortName, vtkPlusDataSource *&aSource)
 
PlusStatus GetToolByPortName (const std::string &aPortName, vtkPlusDataSource *&aSource)
 
DataSourceContainerConstIterator GetToolIteratorBegin () const
 
DataSourceContainerConstIterator GetToolIteratorEnd () const
 
std::string GetToolReferenceFrameName () const
 
virtual int GetUpdateWithDesiredTimestamp ()
 
PlusStatus GetVideoSource (const char *aSourceId, vtkPlusDataSource *&aVideoSource)
 
PlusStatus GetVideoSourceByIndex (const unsigned int index, vtkPlusDataSource *&aVideoSource)
 
DataSourceContainerConstIterator GetVideoSourceIteratorBegin () const
 
DataSourceContainerConstIterator GetVideoSourceIteratorEnd () const
 
std::vector< vtkPlusDataSource * > GetVideoSources () const
 
PlusStatus GetVideoSourcesByPortName (const char *aPortName, std::vector< vtkPlusDataSource * > &sources)
 
PlusStatus GetVideoSourcesByPortName (const std::string &aPortName, std::vector< vtkPlusDataSource * > &sources)
 
virtual PlusStatus InternalUpdate ()
 
virtual bool IsConnected () const
 
virtual bool IsRecording () const
 
virtual bool IsResettable ()
 
virtual bool IsTracker () const
 
virtual bool IsVirtual () const
 
virtual PlusStatus NotifyConfigured ()
 
virtual int OutputChannelCount () const
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual PlusStatus Reset ()
 
virtual PlusStatus SendText (const std::string &textToSend, std::string *textReceived=NULL)
 
PlusStatus SetAcquisitionRate (double aRate)
 
virtual PlusStatus SetBufferSize (vtkPlusChannel &aChannel, int FrameBufferSize, const std::string &aSourceId=std::string(""))
 
virtual void SetDataCollector (vtkPlusDataCollector *_arg)
 
virtual void SetDesiredTimestamp (double)
 
void SetDeviceId (const std::string &id)
 
void SetFieldDataSourcesBufferSize (int aBufferSize)
 
virtual PlusStatus SetImageType (vtkPlusChannel &aChannel, US_IMAGE_TYPE imageType)
 
virtual PlusStatus SetInputFrameSize (vtkPlusDataSource &aSource, unsigned int x, unsigned int y, unsigned int z)
 
virtual void SetLocalTimeOffsetSec (double aTimeOffsetSec)
 
virtual void SetMissingInputGracePeriodSec (double)
 
virtual PlusStatus SetParameter (const std::string &key, const std::string &value)
 
virtual PlusStatus SetPixelType (vtkPlusChannel &aChannel, igsioCommon::VTKScalarPixelType pixelType)
 
virtual void SetStartTime (double startTime)
 
void SetToolReferenceFrameName (const std::string &frameName)
 
void SetToolsBufferSize (int aBufferSize)
 
virtual void SetUpdateWithDesiredTimestamp (int)
 
virtual PlusStatus StartRecording ()
 
virtual PlusStatus StopRecording ()
 
virtual void UpdateWithDesiredTimestampOff ()
 
virtual void UpdateWithDesiredTimestampOn ()
 
virtual PlusStatus WriteToolsToSequenceFile (const std::string &filename, bool useCompression=false)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlusOpenIGTLinkDevice * SafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPlusDevice
static PlusStatus GetToolReferenceFrameFromTrackedFrame (igsioTrackedFrame &aFrame, std::string &aToolReferenceFrameName)
 
static int IsTypeOf (const char *type)
 
static vtkPlusDevice * New ()
 
static vtkPlusDevice * SafeDownCast (vtkObject *o)
 

Protected Member Functions

virtual PlusStatus ClientSocketReconnect ()
 
void OnReceiveTimeout ()
 
virtual PlusStatus ReceiveMessageHeader (igtl::MessageHeader::Pointer &headerMsg)
 
void ReceiveMessageHeaderWithErrorHandling (igtl::MessageHeader::Pointer &headerMsg)
 
virtual PlusStatus SendRequestedMessageTypes ()
 
virtual void SetReconnectOnReceiveTimeout (bool)
 
virtual void SetUseReceivedTimestamps (bool)
 
 vtkPlusOpenIGTLinkDevice ()
 
virtual ~vtkPlusOpenIGTLinkDevice ()
 
- Protected Member Functions inherited from vtkPlusDevice
virtual PlusStatus AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, const igsioVideoFrame &frame, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
 
virtual PlusStatus AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, void *imageDataPtr, US_IMAGE_ORIENTATION usImageOrientation, const FrameSizeType &frameSizeInPx, igsioCommon::VTKScalarPixelType pixelType, unsigned int numberOfScalarComponents, US_IMAGE_TYPE imageType, int numberOfBytesToSkip, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
 
PlusStatus EnsureUniqueDataSourceId (const std::string &aSourceId)
 
vtkXMLDataElement * FindInputChannelElement (vtkXMLDataElement *rootXMLElement, const char *aChannelId)
 
vtkXMLDataElement * FindOutputChannelElement (vtkXMLDataElement *rootXMLElement, const char *aChannelId)
 
vtkXMLDataElement * FindThisDeviceElement (vtkXMLDataElement *rootXMLElement)
 
virtual vtkPlusDataCollector * GetDataCollector ()
 
double GetRecordingStartTime () const
 
bool GetStartThreadForInternalUpdates () const
 
bool HasGracePeriodExpired ()
 
virtual PlusStatus InternalStartRecording ()
 
virtual PlusStatus InternalStopRecording ()
 
virtual void InternalWriteInputChannels (vtkXMLDataElement *rootXMLElement)
 
virtual void InternalWriteOutputChannels (vtkXMLDataElement *rootXMLElement)
 
virtual void SetCorrectlyConfigured (bool)
 
virtual void SetRecordingStartTime (double)
 
virtual void SetStartThreadForInternalUpdates (bool)
 
virtual PlusStatus ToolTimeStampedUpdate (const std::string &aToolSourceId, vtkMatrix4x4 *matrix, ToolStatus status, unsigned long frameNumber, double unfilteredtimestamp, const igsioFieldMapType *customFields=NULL)
 
virtual PlusStatus ToolTimeStampedUpdateWithoutFiltering (const std::string &aToolSourceId, vtkMatrix4x4 *matrix, ToolStatus status, double unfilteredtimestamp, double filteredtimestamp, const igsioFieldMapType *customFields=NULL)
 
 vtkPlusDevice ()
 
virtual ~vtkPlusDevice ()
 

Protected Attributes

igtl::ClientSocket::Pointer ClientSocket
 
double DelayBetweenRetryAttemptsSec
 
int IgtlMessageCrcCheckEnabled
 
igsioTransformName ImageMessageEmbeddedTransformName
 
vtkSmartPointer< vtkPlusIgtlMessageFactory > MessageFactory
 
std::string MessageType
 
int NumberOfRetryAttempts
 
double ReceiveTimeoutSec
 
bool ReconnectOnReceiveTimeout
 
double SendTimeoutSec
 
std::string ServerAddress
 
int ServerPort
 
vtkSmartPointer< vtkIGSIORecursiveCriticalSection > SocketMutex
 
bool UseReceivedTimestamps
 
- Protected Attributes inherited from vtkPlusDevice
double AcquisitionRate
 
int Connected
 
bool CorrectlyConfigured
 
StreamBufferItem * CurrentStreamBufferItem
 
vtkPlusDataCollector * DataCollector
 
double DesiredTimestamp
 
std::string DeviceId
 
DataSourceContainer Fields
 
unsigned long FrameNumber
 
double FrameTimeStamp
 
ChannelContainer InputChannels
 
double LocalTimeOffsetSec
 
double MissingInputGracePeriodSec
 
ChannelContainer OutputChannels
 
int OutputNeedsInitialization
 
std::map< std::string, std::string > Parameters
 
int Recording
 
double RecordingStartTime
 
std::set< std::string > ReportedUnknownTools
 
bool RequireImageOrientationInConfiguration
 
bool RequirePortNameInDeviceSetConfiguration
 
bool StartThreadForInternalUpdates
 
bool ThreadAlive
 
vtkMultiThreader * Threader
 
int ThreadId
 
double TimestampClosestToDesired
 
std::string ToolReferenceFrameName
 
DataSourceContainer Tools
 
int UpdateWithDesiredTimestamp
 
DataSourceContainer VideoSources
 

Additional Inherited Members

- Public Attributes inherited from vtkPlusDevice
double InternalUpdateRate
 
vtkIGSIORecursiveCriticalSection * UpdateMutex
 
vtkTimeStamp UpdateTime
 
- Static Public Attributes inherited from vtkPlusDevice
static const std::string BMODE_PORT_NAME = "B"
 
static const std::string PARAMETER_XML_ELEMENT_TAG = "Parameter"
 
static const std::string PARAMETERS_XML_ELEMENT_TAG = "Parameters"
 
static const std::string RFMODE_PORT_NAME = "Rf"
 
- Static Protected Member Functions inherited from vtkPlusDevice
static void * vtkDataCaptureThread (vtkMultiThreader::ThreadInfo *data)
 
- Static Protected Attributes inherited from vtkPlusDevice
static const int VIRTUAL_DEVICE_FRAME_RATE = 50
 

Detailed Description

Common base class for OpenIGTLink-based tracking and video devices.

Definition at line 26 of file vtkPlusOpenIGTLinkDevice.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusDevice vtkPlusOpenIGTLinkDevice::Superclass

Definition at line 29 of file vtkPlusOpenIGTLinkDevice.h.

Constructor & Destructor Documentation

◆ vtkPlusOpenIGTLinkDevice()

vtkPlusOpenIGTLinkDevice::vtkPlusOpenIGTLinkDevice ( )
protected

Definition at line 20 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ ~vtkPlusOpenIGTLinkDevice()

vtkPlusOpenIGTLinkDevice::~vtkPlusOpenIGTLinkDevice ( )
protectedvirtual

Definition at line 39 of file vtkPlusOpenIGTLinkDevice.cxx.

Member Function Documentation

◆ ClientSocketReconnect()

PlusStatus vtkPlusOpenIGTLinkDevice::ClientSocketReconnect ( )
protectedvirtual

Reconnect the client socket. Used when the connection is established or there is a socket error.

Definition at line 118 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ GetClassName()

virtual const char* vtkPlusOpenIGTLinkDevice::GetClassName ( )
virtual

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusOpenIGTLinkVideoSource, and vtkPlusOpenIGTLinkTracker.

◆ GetIgtlMessageCrcCheckEnabled()

virtual int vtkPlusOpenIGTLinkDevice::GetIgtlMessageCrcCheckEnabled ( )
virtual

Get IGTL CRC check flag (0: disabled, 1: enabled)

◆ GetImageMessageEmbeddedTransformName()

virtual igsioTransformName vtkPlusOpenIGTLinkDevice::GetImageMessageEmbeddedTransformName ( )
virtual

Get image streams to be sent when message type is a type that sends an image

◆ GetReceiveTimeoutSec()

virtual double vtkPlusOpenIGTLinkDevice::GetReceiveTimeoutSec ( )
virtual

Get OpenIGTLink socket receive timeout

◆ GetReconnectOnReceiveTimeout()

virtual bool vtkPlusOpenIGTLinkDevice::GetReconnectOnReceiveTimeout ( )
virtual

Get the ReconnectOnNoData flag

◆ GetSdkVersion()

std::string vtkPlusOpenIGTLinkDevice::GetSdkVersion ( )
virtual

OpenIGTLink version.

Reimplemented from vtkPlusDevice.

Definition at line 68 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ GetSendTimeoutSec()

virtual double vtkPlusOpenIGTLinkDevice::GetSendTimeoutSec ( )
virtual

Get OpenIGTLink socket send timeout

◆ GetServerPort()

virtual int vtkPlusOpenIGTLinkDevice::GetServerPort ( )
virtual

Get OpenIGTLink server port

◆ InternalConnect()

PlusStatus vtkPlusOpenIGTLinkDevice::InternalConnect ( )
virtual

Connect to device

Reimplemented from vtkPlusDevice.

Definition at line 76 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusOpenIGTLinkDevice::InternalDisconnect ( )
virtual

Disconnect from device

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusOpenIGTLinkTracker.

Definition at line 93 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ IsA()

virtual int vtkPlusOpenIGTLinkDevice::IsA ( const char *  type)
virtual

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusOpenIGTLinkVideoSource, and vtkPlusOpenIGTLinkTracker.

◆ IsTypeOf()

static int vtkPlusOpenIGTLinkDevice::IsTypeOf ( const char *  type)
static

◆ OnReceiveTimeout()

void vtkPlusOpenIGTLinkDevice::OnReceiveTimeout ( )
protected

This method is called when receiving a message is timed out. If ReconnectOnReceiveTimeout is enabled then this method attempts to reconnect to the server.

Definition at line 222 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ PrintSelf()

void vtkPlusOpenIGTLinkDevice::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusOpenIGTLinkVideoSource, and vtkPlusOpenIGTLinkTracker.

Definition at line 50 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ Probe()

PlusStatus vtkPlusOpenIGTLinkDevice::Probe ( )
virtual

Probe to see if the tracking system is present on the specified address.

Reimplemented from vtkPlusDevice.

Definition at line 103 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusOpenIGTLinkDevice::ReadConfiguration ( vtkXMLDataElement *  config)
virtual

Read configuration from xml data

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusOpenIGTLinkTracker, and vtkPlusOpenIGTLinkVideoSource.

Definition at line 318 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ ReceiveMessageHeader()

PlusStatus vtkPlusOpenIGTLinkDevice::ReceiveMessageHeader ( igtl::MessageHeader::Pointer &  headerMsg)
protectedvirtual

Receive an OpenITGLink message header. Returns PLUS_FAIL if there was a socket error. The headerMsg is NULL is no data is received.

Definition at line 252 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ ReceiveMessageHeaderWithErrorHandling()

void vtkPlusOpenIGTLinkDevice::ReceiveMessageHeaderWithErrorHandling ( igtl::MessageHeader::Pointer &  headerMsg)
protected

Calls ReceiveMessageHeader and logs the error and/or reconnect as needed.

Definition at line 232 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ SafeDownCast()

static vtkPlusOpenIGTLinkDevice* vtkPlusOpenIGTLinkDevice::SafeDownCast ( vtkObject *  o)
static

◆ SendMessage()

bool vtkPlusOpenIGTLinkDevice::SendMessage ( igtl::MessageBase::Pointer  packedMessage)

Send a message to the connected server

Definition at line 348 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ SendRequestedMessageTypes()

PlusStatus vtkPlusOpenIGTLinkDevice::SendRequestedMessageTypes ( )
protectedvirtual

Sends the requested message types when connection is established

Reimplemented in vtkPlusOpenIGTLinkTracker.

Definition at line 168 of file vtkPlusOpenIGTLinkDevice.cxx.

◆ SetIgtlMessageCrcCheckEnabled()

virtual void vtkPlusOpenIGTLinkDevice::SetIgtlMessageCrcCheckEnabled ( int  )
virtual

Set IGTL CRC check flag (0: disabled, 1: enabled)

◆ SetImageMessageEmbeddedTransformName() [1/2]

virtual void vtkPlusOpenIGTLinkDevice::SetImageMessageEmbeddedTransformName ( igsioTransformName  )
virtual

Set image streams to be sent when message type is a type that sends an image

◆ SetImageMessageEmbeddedTransformName() [2/2]

virtual void vtkPlusOpenIGTLinkDevice::SetImageMessageEmbeddedTransformName ( std::string  )
virtual

◆ SetReceiveTimeoutSec()

virtual void vtkPlusOpenIGTLinkDevice::SetReceiveTimeoutSec ( double  )
virtual

Set OpenIGTLink socket receive timeout

◆ SetReconnectOnReceiveTimeout()

virtual void vtkPlusOpenIGTLinkDevice::SetReconnectOnReceiveTimeout ( bool  )
protectedvirtual

Set the ReconnectOnReceiveTimeout flag

◆ SetSendTimeoutSec()

virtual void vtkPlusOpenIGTLinkDevice::SetSendTimeoutSec ( double  )
virtual

Set OpenIGTLink socket send timeout

◆ SetServerPort()

virtual void vtkPlusOpenIGTLinkDevice::SetServerPort ( int  )
virtual

Set OpenIGTLink server port

◆ SetUseReceivedTimestamps()

virtual void vtkPlusOpenIGTLinkDevice::SetUseReceivedTimestamps ( bool  )
protectedvirtual

◆ vtkGetStdStringMacro() [1/2]

vtkPlusOpenIGTLinkDevice::vtkGetStdStringMacro ( MessageType  )

Get OpenIGTLink message type

◆ vtkGetStdStringMacro() [2/2]

vtkPlusOpenIGTLinkDevice::vtkGetStdStringMacro ( ServerAddress  )

Get OpenIGTLink server address

◆ vtkSetStdStringMacro() [1/2]

vtkPlusOpenIGTLinkDevice::vtkSetStdStringMacro ( MessageType  )

Set OpenIGTLink message type

◆ vtkSetStdStringMacro() [2/2]

vtkPlusOpenIGTLinkDevice::vtkSetStdStringMacro ( ServerAddress  )

Set OpenIGTLink server address

◆ WriteConfiguration()

PlusStatus vtkPlusOpenIGTLinkDevice::WriteConfiguration ( vtkXMLDataElement *  config)
virtual

Write configuration to xml data

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusOpenIGTLinkTracker, and vtkPlusOpenIGTLinkVideoSource.

Definition at line 333 of file vtkPlusOpenIGTLinkDevice.cxx.

Member Data Documentation

◆ ClientSocket

igtl::ClientSocket::Pointer vtkPlusOpenIGTLinkDevice::ClientSocket
protected

OpenIGTLink client socket

Definition at line 158 of file vtkPlusOpenIGTLinkDevice.h.

◆ DelayBetweenRetryAttemptsSec

double vtkPlusOpenIGTLinkDevice::DelayBetweenRetryAttemptsSec
protected

Delay between retry attempts

Definition at line 149 of file vtkPlusOpenIGTLinkDevice.h.

◆ IgtlMessageCrcCheckEnabled

int vtkPlusOpenIGTLinkDevice::IgtlMessageCrcCheckEnabled
protected

Flag for IGTL CRC check (0: disabled, 1: enabled)

Definition at line 143 of file vtkPlusOpenIGTLinkDevice.h.

◆ ImageMessageEmbeddedTransformName

igsioTransformName vtkPlusOpenIGTLinkDevice::ImageMessageEmbeddedTransformName
protected

Image stream to send when message type wants to send an image

Definition at line 130 of file vtkPlusOpenIGTLinkDevice.h.

◆ MessageFactory

vtkSmartPointer<vtkPlusIgtlMessageFactory> vtkPlusOpenIGTLinkDevice::MessageFactory
protected

Definition at line 152 of file vtkPlusOpenIGTLinkDevice.h.

◆ MessageType

std::string vtkPlusOpenIGTLinkDevice::MessageType
protected

OpenIGTLink message type

Definition at line 124 of file vtkPlusOpenIGTLinkDevice.h.

◆ NumberOfRetryAttempts

int vtkPlusOpenIGTLinkDevice::NumberOfRetryAttempts
protected

Number of retry attempts for message sending to and receiving from the server

Definition at line 146 of file vtkPlusOpenIGTLinkDevice.h.

◆ ReceiveTimeoutSec

double vtkPlusOpenIGTLinkDevice::ReceiveTimeoutSec
protected

How long a socket waits when receiving/sending before timing out

Definition at line 139 of file vtkPlusOpenIGTLinkDevice.h.

◆ ReconnectOnReceiveTimeout

bool vtkPlusOpenIGTLinkDevice::ReconnectOnReceiveTimeout
protected

Attempt a reconnection if no data is received

Definition at line 161 of file vtkPlusOpenIGTLinkDevice.h.

◆ SendTimeoutSec

double vtkPlusOpenIGTLinkDevice::SendTimeoutSec
protected

Definition at line 140 of file vtkPlusOpenIGTLinkDevice.h.

◆ ServerAddress

std::string vtkPlusOpenIGTLinkDevice::ServerAddress
protected

OpenIGTLink server address

Definition at line 133 of file vtkPlusOpenIGTLinkDevice.h.

◆ ServerPort

int vtkPlusOpenIGTLinkDevice::ServerPort
protected

OpenIGTLink server port

Definition at line 136 of file vtkPlusOpenIGTLinkDevice.h.

◆ SocketMutex

vtkSmartPointer<vtkIGSIORecursiveCriticalSection> vtkPlusOpenIGTLinkDevice::SocketMutex
protected

Control access to the socket

Definition at line 155 of file vtkPlusOpenIGTLinkDevice.h.

◆ UseReceivedTimestamps

bool vtkPlusOpenIGTLinkDevice::UseReceivedTimestamps
protected

Use the timestamp embedded in the OpenIGTLink message (the timestamp is converted form the UTC time to system time). If it is false then the time of reception is used as timestamp.

Definition at line 167 of file vtkPlusOpenIGTLinkDevice.h.

The documentation for this class was generated from the following files:
Generated on Thu Apr 25 2024 01:38:15 for PlusLib by   doxygen 1.8.15