vtkPlusGenericSerialCommand Class Reference

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

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

Inheritance diagram for vtkPlusGenericSerialCommand:

Collaboration diagram for vtkPlusGenericSerialCommand:

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 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	SetNameToSerial ()
virtual void	SetResponseExpected (bool)
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 vtkPlusGenericSerialCommand *	New ()
static vtkPlusGenericSerialCommand *	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
std::string	GetCommandName () const
std::string	GetCommandValue () const
void	SetCommandName (const std::string &text)
void	SetCommandValue (const std::string &text)
	vtkPlusGenericSerialCommand ()
virtual	~vtkPlusGenericSerialCommand ()
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 is for communicating with vtkPlusGenericSerialDevices.

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

Definition at line 23 of file vtkPlusGenericSerialCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusGenericSerialCommand::Superclass

Definition at line 28 of file vtkPlusGenericSerialCommand.h.

Constructor & Destructor Documentation

vtkPlusGenericSerialCommand()

vtkPlusGenericSerialCommand::vtkPlusGenericSerialCommand ( )

protected

Definition at line 21 of file vtkPlusGenericSerialCommand.cxx.

~vtkPlusGenericSerialCommand()

vtkPlusGenericSerialCommand::~vtkPlusGenericSerialCommand ( )

protectedvirtual

Definition at line 29 of file vtkPlusGenericSerialCommand.cxx.

Member Function Documentation

Clone()

virtual vtkPlusCommand* vtkPlusGenericSerialCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 30 of file vtkPlusGenericSerialCommand.h.

Execute()

PlusStatus vtkPlusGenericSerialCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 129 of file vtkPlusGenericSerialCommand.cxx.

GetClassName()

virtual const char* vtkPlusGenericSerialCommand::GetClassName ( )

virtual

GetCommandName()

std::string vtkPlusGenericSerialCommand::GetCommandName ( ) const

protected

Definition at line 71 of file vtkPlusGenericSerialCommand.cxx.

GetCommandNames()

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

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 40 of file vtkPlusGenericSerialCommand.cxx.

GetCommandValue()

std::string vtkPlusGenericSerialCommand::GetCommandValue ( ) const

protected

Definition at line 83 of file vtkPlusGenericSerialCommand.cxx.

GetDescription()

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

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 47 of file vtkPlusGenericSerialCommand.cxx.

GetDeviceId()

std::string vtkPlusGenericSerialCommand::GetDeviceId ( ) const

virtual

Id of the device that the text will be sent to

Definition at line 59 of file vtkPlusGenericSerialCommand.cxx.

GetResponseExpected()

virtual bool vtkPlusGenericSerialCommand::GetResponseExpected ( )

virtual

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusGenericSerialCommand* vtkPlusGenericSerialCommand::New ( )

static

PrintSelf()

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

virtual

Reimplemented from vtkPlusCommand.

Definition at line 95 of file vtkPlusGenericSerialCommand.cxx.

ReadConfiguration()

PlusStatus vtkPlusGenericSerialCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 101 of file vtkPlusGenericSerialCommand.cxx.

ResponseExpectedOff()

virtual void vtkPlusGenericSerialCommand::ResponseExpectedOff ( )

virtual

ResponseExpectedOn()

virtual void vtkPlusGenericSerialCommand::ResponseExpectedOn ( )

virtual

SafeDownCast()

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

static

SetCommandName()

void vtkPlusGenericSerialCommand::SetCommandName ( const std::string &  text )

protected

Definition at line 77 of file vtkPlusGenericSerialCommand.cxx.

SetCommandValue()

void vtkPlusGenericSerialCommand::SetCommandValue ( const std::string &  text )

protected

Definition at line 89 of file vtkPlusGenericSerialCommand.cxx.

SetDeviceId()

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

virtual

Definition at line 65 of file vtkPlusGenericSerialCommand.cxx.

SetNameToSerial()

void vtkPlusGenericSerialCommand::SetNameToSerial

(

)

Definition at line 34 of file vtkPlusGenericSerialCommand.cxx.

SetResponseExpected()

virtual void vtkPlusGenericSerialCommand::SetResponseExpected ( bool  )

virtual

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

WriteConfiguration()

PlusStatus vtkPlusGenericSerialCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 116 of file vtkPlusGenericSerialCommand.cxx.

---

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

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