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 | Static Public Attributes | Protected Member Functions | Protected Attributes
vtkPlusGenericSerialDevice Class Reference
DataCollection

Generic interface for communicating with a serial device. More...

#include <src/PlusDataCollection/vtkPlusGenericSerialDevice.h>

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

Public Types

enum  ReplyTermination { REQUIRE_LINE_ENDING = 0, REQUIRE_NOT_EMPTY = 1, ANY = 2 }
 
typedef vtkPlusDevice Superclass
 
- Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
PlusStatus GetCTS (bool &onOff)
 
PlusStatus GetDSR (bool &onOff)
 
virtual bool GetDTR ()
 
virtual std::string GetLineEnding ()
 
virtual bool GetRTS ()
 
PlusStatus InternalConnect ()
 
virtual PlusStatus InternalDisconnect ()
 
PlusStatus InternalUpdate ()
 
virtual int IsA (const char *type)
 
virtual bool IsTracker () const
 
virtual PlusStatus NotifyConfigured ()
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *config)
 
virtual PlusStatus ReceiveResponse (std::string &textReceived, ReplyTermination acceptReply=REQUIRE_LINE_ENDING)
 
virtual PlusStatus SendText (const std::string &textToSend, std::string *textReceived=NULL) VTK_OVERRIDE
 
virtual PlusStatus SendText (const std::string &textToSend, std::string *textReceived, ReplyTermination acceptReply)
 
virtual void SetBaudRate (unsigned long)
 
PlusStatus SetDTR (bool onOff)
 
void SetLineEnding (const char *lineEndingHex)
 
virtual void SetMaximumReplyDelaySec (double)
 
virtual void SetMaximumReplyDurationSec (double)
 
PlusStatus SetRTS (bool onOff)
 
virtual void SetSerialPort (unsigned long)
 
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 std::string GetSdkVersion ()
 
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 bool IsConnected () const
 
virtual bool IsRecording () const
 
virtual bool IsResettable ()
 
virtual bool IsVirtual () const
 
virtual int OutputChannelCount () const
 
virtual PlusStatus Probe ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual PlusStatus Reset ()
 
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 vtkPlusGenericSerialDevice * New ()
 
static vtkPlusGenericSerialDevice * 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)
 

Static Public Attributes

static const char * SERIAL_COMMAND_GET_CTS = "GetCTS"
 
static const char * SERIAL_COMMAND_GET_RTS = "GetRTS"
 
static const char * SERIAL_COMMAND_SET_RTS = "SetRTS"
 
- 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"
 

Protected Member Functions

 vtkPlusGenericSerialDevice ()
 
virtual bool WaitForResponse ()
 
 ~vtkPlusGenericSerialDevice ()
 
- 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

unsigned long BaudRate
 
bool DTR
 
vtkPlusDataSource * FieldDataSource
 
long FrameNumber
 
std::string LineEnding
 
std::string LineEndingBin
 
double MaximumReplyDelaySec
 
double MaximumReplyDurationSec
 
vtkSmartPointer< vtkIGSIORecursiveCriticalSection > Mutex
 
bool RTS
 
SerialLine * Serial
 
unsigned long SerialPort
 
- 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 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

Generic interface for communicating with a serial device.

This class communicates with any serial (RS-232) device. It allows sending and receiving data using OpenIGTLink commands.

Definition at line 25 of file vtkPlusGenericSerialDevice.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusDevice vtkPlusGenericSerialDevice::Superclass

Definition at line 30 of file vtkPlusGenericSerialDevice.h.

Member Enumeration Documentation

◆ ReplyTermination

enum vtkPlusGenericSerialDevice::ReplyTermination

Specifies what kind of response is expected from the device

Enumerator
REQUIRE_LINE_ENDING 
REQUIRE_NOT_EMPTY 
ANY 

Definition at line 68 of file vtkPlusGenericSerialDevice.h.

Constructor & Destructor Documentation

◆ vtkPlusGenericSerialDevice()

vtkPlusGenericSerialDevice::vtkPlusGenericSerialDevice ( )
protected

Definition at line 61 of file vtkPlusGenericSerialDevice.cxx.

◆ ~vtkPlusGenericSerialDevice()

vtkPlusGenericSerialDevice::~vtkPlusGenericSerialDevice ( )
protected

Definition at line 82 of file vtkPlusGenericSerialDevice.cxx.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPlusGenericSerialDevice::GetClassName ( )
virtual

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusMicrochipTracker, and vtkPlusWitMotionTracker.

◆ GetCTS()

PlusStatus vtkPlusGenericSerialDevice::GetCTS ( bool &  onOff)

Gets the CTS (clear-to-send) line.

Definition at line 251 of file vtkPlusGenericSerialDevice.cxx.

◆ GetDSR()

PlusStatus vtkPlusGenericSerialDevice::GetDSR ( bool &  onOff)

Gets the DTR (data-set-ready) line.

Definition at line 242 of file vtkPlusGenericSerialDevice.cxx.

◆ GetDTR()

virtual bool vtkPlusGenericSerialDevice::GetDTR ( )
virtual

Gets the DTR (data-terminal-ready) line.

◆ GetLineEnding()

virtual std::string vtkPlusGenericSerialDevice::GetLineEnding ( )
virtual

◆ GetRTS()

virtual bool vtkPlusGenericSerialDevice::GetRTS ( )
virtual

Gets the RTS (request-to-send) line.

◆ InternalConnect()

PlusStatus vtkPlusGenericSerialDevice::InternalConnect ( )
virtual

Connect to device

Reimplemented from vtkPlusDevice.

Definition at line 104 of file vtkPlusGenericSerialDevice.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusGenericSerialDevice::InternalDisconnect ( )
virtual

Disconnect from device

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusMicrochipTracker.

Definition at line 160 of file vtkPlusGenericSerialDevice.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusGenericSerialDevice::InternalUpdate ( )
virtual

Get an update from the tracking system and push the new transforms to the tools. This should only be used within vtkTracker.cxx. This method is called by the tracker thread.

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusWitMotionTracker.

Definition at line 171 of file vtkPlusGenericSerialDevice.cxx.

◆ IsA()

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

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusMicrochipTracker, and vtkPlusWitMotionTracker.

◆ IsTracker()

virtual bool vtkPlusGenericSerialDevice::IsTracker ( ) const
inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusMicrochipTracker, and vtkPlusWitMotionTracker.

Definition at line 56 of file vtkPlusGenericSerialDevice.h.

◆ IsTypeOf()

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

◆ New()

static vtkPlusGenericSerialDevice* vtkPlusGenericSerialDevice::New ( )
static

◆ NotifyConfigured()

PlusStatus vtkPlusGenericSerialDevice::NotifyConfigured ( )
virtual

Perform any completion tasks once configured

Reimplemented from vtkPlusDevice.

Reimplemented in vtkPlusWitMotionTracker.

Definition at line 374 of file vtkPlusGenericSerialDevice.cxx.

◆ PrintSelf()

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

Reimplemented from vtkPlusDevice.

Definition at line 98 of file vtkPlusGenericSerialDevice.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusGenericSerialDevice::ReadConfiguration ( vtkXMLDataElement *  config)
virtual

Read configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 385 of file vtkPlusGenericSerialDevice.cxx.

◆ ReceiveResponse()

PlusStatus vtkPlusGenericSerialDevice::ReceiveResponse ( std::string &  textReceived,
ReplyTermination  acceptReply = REQUIRE_LINE_ENDING 
)
virtual

Receive a response from the serial device.

In case that a device has both terminated and unterminated responses, acceptReply needs to be specified per command.

Definition at line 319 of file vtkPlusGenericSerialDevice.cxx.

◆ SafeDownCast()

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

◆ SendText() [1/2]

virtual PlusStatus vtkPlusGenericSerialDevice::SendText ( const std::string &  textToSend,
std::string *  textReceived = NULL 
)
inlinevirtual

Send text to the serial device. If a non-NULL pointer is passed as textReceived then the device waits for a response and returns it in textReceived.

If acceptReply is not REQUIRE_NOT_EMPTY, command is considered successful if non-empty reply is received within timeout, even if it not terminated by a LineEnding. Some devices (e.g. Velmex VXM) has both kinds of commands, e.g. V command is not CR terminated: http://www.velmex.com/Downloads/Spec_Sheets/VXM%20-%20%20Command%20Summary%20Rev%20B%20814.pdf

Reimplemented from vtkPlusDevice.

Definition at line 84 of file vtkPlusGenericSerialDevice.h.

◆ SendText() [2/2]

PlusStatus vtkPlusGenericSerialDevice::SendText ( const std::string &  textToSend,
std::string *  textReceived,
ReplyTermination  acceptReply 
)
virtual

Definition at line 260 of file vtkPlusGenericSerialDevice.cxx.

◆ SetBaudRate()

virtual void vtkPlusGenericSerialDevice::SetBaudRate ( unsigned long  )
virtual

◆ SetDTR()

PlusStatus vtkPlusGenericSerialDevice::SetDTR ( bool  onOff)

Sets the DTR (data-terminal-ready) line.

Definition at line 194 of file vtkPlusGenericSerialDevice.cxx.

◆ SetLineEnding()

void vtkPlusGenericSerialDevice::SetLineEnding ( const char *  lineEndingHex)

Line ending in hex encoded form, separated by spaces (e.g., "13 10")

Definition at line 409 of file vtkPlusGenericSerialDevice.cxx.

◆ SetMaximumReplyDelaySec()

virtual void vtkPlusGenericSerialDevice::SetMaximumReplyDelaySec ( double  )
virtual

◆ SetMaximumReplyDurationSec()

virtual void vtkPlusGenericSerialDevice::SetMaximumReplyDurationSec ( double  )
virtual

◆ SetRTS()

PlusStatus vtkPlusGenericSerialDevice::SetRTS ( bool  onOff)

Sets the RTS (request-to-send) line.

Definition at line 218 of file vtkPlusGenericSerialDevice.cxx.

◆ SetSerialPort()

virtual void vtkPlusGenericSerialDevice::SetSerialPort ( unsigned long  )
virtual

◆ WaitForResponse()

bool vtkPlusGenericSerialDevice::WaitForResponse ( )
protectedvirtual

Wait until the serial device makes some data available for reading but maximum up to ReplyTimeoutSec

Definition at line 300 of file vtkPlusGenericSerialDevice.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlusGenericSerialDevice::WriteConfiguration ( vtkXMLDataElement *  config)
virtual

Write configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 397 of file vtkPlusGenericSerialDevice.cxx.

Member Data Documentation

◆ BaudRate

unsigned long vtkPlusGenericSerialDevice::BaudRate
protected

Baud rate for serial communication.

Definition at line 134 of file vtkPlusGenericSerialDevice.h.

◆ DTR

bool vtkPlusGenericSerialDevice::DTR
protected

Data Terminal Ready

Definition at line 137 of file vtkPlusGenericSerialDevice.h.

◆ FieldDataSource

vtkPlusDataSource* vtkPlusGenericSerialDevice::FieldDataSource
protected

Definition at line 155 of file vtkPlusGenericSerialDevice.h.

◆ FrameNumber

long vtkPlusGenericSerialDevice::FrameNumber
protected

Definition at line 154 of file vtkPlusGenericSerialDevice.h.

◆ LineEnding

std::string vtkPlusGenericSerialDevice::LineEnding
protected

Characters that indicate end of sent or received text data. Each character is encoded in 2-digit hexadecimal, separate by spaces.

Definition at line 143 of file vtkPlusGenericSerialDevice.h.

◆ LineEndingBin

std::string vtkPlusGenericSerialDevice::LineEndingBin
protected

Line ending as simple string. Decoded from LineEnding and stored as a member variable to avoid decoding each time it is used.

Definition at line 146 of file vtkPlusGenericSerialDevice.h.

◆ MaximumReplyDelaySec

double vtkPlusGenericSerialDevice::MaximumReplyDelaySec
protected

Maximum time to wait for the device to start replying

Definition at line 149 of file vtkPlusGenericSerialDevice.h.

◆ MaximumReplyDurationSec

double vtkPlusGenericSerialDevice::MaximumReplyDurationSec
protected

Maximum time to wait for the device to finish replying

Definition at line 152 of file vtkPlusGenericSerialDevice.h.

◆ Mutex

vtkSmartPointer<vtkIGSIORecursiveCriticalSection> vtkPlusGenericSerialDevice::Mutex
protected

Mutex instance for sharing the serial line between update thread and command execution thread

Definition at line 158 of file vtkPlusGenericSerialDevice.h.

◆ RTS

bool vtkPlusGenericSerialDevice::RTS
protected

Request To Send

Definition at line 140 of file vtkPlusGenericSerialDevice.h.

◆ Serial

SerialLine* vtkPlusGenericSerialDevice::Serial
protected

Serial (RS232) line connection

Definition at line 128 of file vtkPlusGenericSerialDevice.h.

◆ SERIAL_COMMAND_GET_CTS

const char * vtkPlusGenericSerialDevice::SERIAL_COMMAND_GET_CTS = "GetCTS"
static

Definition at line 35 of file vtkPlusGenericSerialDevice.h.

◆ SERIAL_COMMAND_GET_RTS

const char * vtkPlusGenericSerialDevice::SERIAL_COMMAND_GET_RTS = "GetRTS"
static

Definition at line 33 of file vtkPlusGenericSerialDevice.h.

◆ SERIAL_COMMAND_SET_RTS

const char * vtkPlusGenericSerialDevice::SERIAL_COMMAND_SET_RTS = "SetRTS"
static

Definition at line 34 of file vtkPlusGenericSerialDevice.h.

◆ SerialPort

unsigned long vtkPlusGenericSerialDevice::SerialPort
protected

Used COM port number for serial communication (ComPort: 1 => Port name: "COM1")

Definition at line 131 of file vtkPlusGenericSerialDevice.h.

The documentation for this class was generated from the following files:
Generated on Fri Apr 26 2024 01:37:57 for PlusLib by   doxygen 1.8.15