vtkPlusSendTextCommand Class Reference

This command send text to a device and optionally return with a response textThis command is used for communicating with a generic serial device. More...

#include <src/PlusServer/Commands/vtkPlusSendTextCommand.h>

Inheritance diagram for vtkPlusSendTextCommand:

Collaboration diagram for vtkPlusSendTextCommand:

Public Types
typedef vtkPlusCommand	Superclass

Public Member Functions
virtual vtkPlusCommand *	Clone ()
virtual PlusStatus	Execute ()
virtual const char *	GetClassName ()
virtual void	GetCommandNames (std::list< std::string > &cmdNames)
virtual std::string	GetDescription (const std::string &commandName)
virtual std::string	GetDeviceId () const
virtual bool	GetResponseExpected ()
virtual std::string	GetResponseText () const
virtual std::string	GetText () const
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *aConfig)
virtual void	ResponseExpectedOff ()
virtual void	ResponseExpectedOn ()
virtual void	SetDeviceId (const std::string &deviceId)
void	SetNameToSendText ()
virtual void	SetResponseExpected (bool)
virtual void	SetResponseText (const std::string &responseText)
virtual void	SetText (const std::string &text)
virtual PlusStatus	WriteConfiguration (vtkXMLDataElement *aConfig)
Public Member Functions inherited from vtkPlusCommand
virtual int	GetClientId ()
virtual uint32_t	GetId ()
virtual bool	GetRespondWithCommandMessage ()
void	PopCommandResponses (PlusCommandResponseList &responses)
virtual void	SetClientId (int)
virtual void	SetCommandProcessor (vtkPlusCommandProcessor *processor)
virtual void	SetId (uint32_t)
void	SetMetaData (const igtl::MessageBase::MetaDataMap &metaData)
virtual void	SetRespondWithCommandMessage (bool)
	vtkGetStdStringMacro (Name)
	vtkGetStdStringMacro (DeviceName)
	vtkSetStdStringMacro (Name)
	vtkSetStdStringMacro (DeviceName)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkPlusSendTextCommand *	New ()
static vtkPlusSendTextCommand *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkPlusCommand
static PlusStatus	GenerateCommandDeviceName (const std::string &uid, std::string &outDeviceName)
static std::string	GenerateReplyDeviceName (uint32_t uid)
static std::string	GetPrefixFromCommandDeviceName (const std::string &deviceName)
static std::string	GetUidFromCommandDeviceName (const std::string &deviceName)
static bool	IsCommandDeviceName (const std::string &deviceName)
static bool	IsReplyDeviceName (const std::string &deviceName, const std::string &uid=std::string(""))

Protected Member Functions
	vtkPlusSendTextCommand ()
virtual	~vtkPlusSendTextCommand ()
Protected Member Functions inherited from vtkPlusCommand
virtual vtkPlusDataCollector *	GetDataCollector ()
virtual vtkIGSIOTransformRepository *	GetTransformRepository ()
void	QueueCommandResponse (PlusStatus status, const std::string &message, const std::string &error="", const igtl::MessageBase::MetaDataMap *metaData=nullptr)
PlusStatus	ValidateName ()
	vtkPlusCommand ()
virtual	~vtkPlusCommand ()

Additional Inherited Members
Static Public Attributes inherited from vtkPlusCommand
static const std::string	DEVICE_NAME_COMMAND = "CMD"
static const std::string	DEVICE_NAME_REPLY = "ACK"
Protected Attributes inherited from vtkPlusCommand
int	ClientId
vtkPlusCommandProcessor *	CommandProcessor
PlusCommandResponseList	CommandResponseQueue
std::string	DeviceName
uint32_t	Id
igtl::MessageBase::MetaDataMap	MetaData
std::string	Name
bool	RespondWithCommandMessage

Detailed Description

This command send text to a device and optionally return with a response text

This command is used for communicating with a generic serial device.

Definition at line 23 of file vtkPlusSendTextCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusSendTextCommand::Superclass

Definition at line 28 of file vtkPlusSendTextCommand.h.

Constructor & Destructor Documentation

vtkPlusSendTextCommand()

vtkPlusSendTextCommand::vtkPlusSendTextCommand ( )

protected

Definition at line 20 of file vtkPlusSendTextCommand.cxx.

~vtkPlusSendTextCommand()

vtkPlusSendTextCommand::~vtkPlusSendTextCommand ( )

protectedvirtual

Definition at line 28 of file vtkPlusSendTextCommand.cxx.

Member Function Documentation

Clone()

virtual vtkPlusCommand* vtkPlusSendTextCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 30 of file vtkPlusSendTextCommand.h.

Execute()

PlusStatus vtkPlusSendTextCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 125 of file vtkPlusSendTextCommand.cxx.

GetClassName()

virtual const char* vtkPlusSendTextCommand::GetClassName ( )

virtual

GetCommandNames()

void vtkPlusSendTextCommand::GetCommandNames ( std::list< std::string > &  cmdNames )

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 39 of file vtkPlusSendTextCommand.cxx.

GetDescription()

std::string vtkPlusSendTextCommand::GetDescription ( const std::string &  commandName )

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 46 of file vtkPlusSendTextCommand.cxx.

GetDeviceId()

std::string vtkPlusSendTextCommand::GetDeviceId ( ) const

virtual

Id of the device that the text will be sent to

Definition at line 58 of file vtkPlusSendTextCommand.cxx.

GetResponseExpected()

virtual bool vtkPlusSendTextCommand::GetResponseExpected ( )

virtual

GetResponseText()

std::string vtkPlusSendTextCommand::GetResponseText ( ) const

virtual

Text to send

Definition at line 82 of file vtkPlusSendTextCommand.cxx.

GetText()

std::string vtkPlusSendTextCommand::GetText ( ) const

virtual

Text to send

Definition at line 70 of file vtkPlusSendTextCommand.cxx.

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusSendTextCommand* vtkPlusSendTextCommand::New ( )

static

PrintSelf()

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

virtual

Reimplemented from vtkPlusCommand.

Definition at line 94 of file vtkPlusSendTextCommand.cxx.

ReadConfiguration()

PlusStatus vtkPlusSendTextCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 101 of file vtkPlusSendTextCommand.cxx.

ResponseExpectedOff()

virtual void vtkPlusSendTextCommand::ResponseExpectedOff ( )

virtual

ResponseExpectedOn()

virtual void vtkPlusSendTextCommand::ResponseExpectedOn ( )

virtual

SafeDownCast()

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

static

SetDeviceId()

void vtkPlusSendTextCommand::SetDeviceId ( const std::string &  deviceId )

virtual

Definition at line 64 of file vtkPlusSendTextCommand.cxx.

SetNameToSendText()

void vtkPlusSendTextCommand::SetNameToSendText

(

)

Definition at line 33 of file vtkPlusSendTextCommand.cxx.

SetResponseExpected()

virtual void vtkPlusSendTextCommand::SetResponseExpected ( bool  )

virtual

If true then the command waits for a response and returns with the received text in the command response.

SetResponseText()

void vtkPlusSendTextCommand::SetResponseText ( const std::string &  responseText )

virtual

Definition at line 88 of file vtkPlusSendTextCommand.cxx.

SetText()

void vtkPlusSendTextCommand::SetText ( const std::string &  text )

virtual

Definition at line 76 of file vtkPlusSendTextCommand.cxx.

WriteConfiguration()

PlusStatus vtkPlusSendTextCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 113 of file vtkPlusSendTextCommand.cxx.

---

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

• src/PlusServer/Commands/vtkPlusSendTextCommand.h
• src/PlusServer/Commands/vtkPlusSendTextCommand.cxx