vtkPlusCapistranoCommand Class Reference

This command is for communicating with vtkPlusCapistranoDevice.This command is used for communicating with a Capistrano device. More...

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

Inheritance diagram for vtkPlusCapistranoCommand:

Collaboration diagram for vtkPlusCapistranoCommand:

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)
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 vtkPlusCapistranoCommand *	New ()
static vtkPlusCapistranoCommand *	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)
	vtkPlusCapistranoCommand ()
virtual	~vtkPlusCapistranoCommand ()
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 ()

Protected Attributes
std::list< std::pair< std::string, std::string > >	RequestedParameterChanges
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

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"

Detailed Description

This command is for communicating with vtkPlusCapistranoDevice.

This command is used for communicating with a Capistrano device.

Definition at line 23 of file vtkPlusCapistranoCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusCapistranoCommand::Superclass

Definition at line 28 of file vtkPlusCapistranoCommand.h.

Constructor & Destructor Documentation

vtkPlusCapistranoCommand()

vtkPlusCapistranoCommand::vtkPlusCapistranoCommand ( )

protected

Definition at line 34 of file vtkPlusCapistranoCommand.cxx.

~vtkPlusCapistranoCommand()

vtkPlusCapistranoCommand::~vtkPlusCapistranoCommand ( )

protectedvirtual

Definition at line 42 of file vtkPlusCapistranoCommand.cxx.

Member Function Documentation

Clone()

virtual vtkPlusCommand* vtkPlusCapistranoCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 30 of file vtkPlusCapistranoCommand.h.

Execute()

PlusStatus vtkPlusCapistranoCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 158 of file vtkPlusCapistranoCommand.cxx.

GetClassName()

virtual const char* vtkPlusCapistranoCommand::GetClassName ( )

virtual

GetCommandName()

std::string vtkPlusCapistranoCommand::GetCommandName ( ) const

protected

Definition at line 78 of file vtkPlusCapistranoCommand.cxx.

GetCommandNames()

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

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 47 of file vtkPlusCapistranoCommand.cxx.

GetCommandValue()

std::string vtkPlusCapistranoCommand::GetCommandValue ( ) const

protected

Definition at line 90 of file vtkPlusCapistranoCommand.cxx.

GetDescription()

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

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 54 of file vtkPlusCapistranoCommand.cxx.

GetDeviceId()

std::string vtkPlusCapistranoCommand::GetDeviceId ( ) const

virtual

Id of the device that the text will be sent to

Definition at line 66 of file vtkPlusCapistranoCommand.cxx.

GetResponseExpected()

virtual bool vtkPlusCapistranoCommand::GetResponseExpected ( )

virtual

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusCapistranoCommand* vtkPlusCapistranoCommand::New ( )

static

PrintSelf()

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

virtual

Reimplemented from vtkPlusCommand.

Definition at line 102 of file vtkPlusCapistranoCommand.cxx.

ReadConfiguration()

PlusStatus vtkPlusCapistranoCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 108 of file vtkPlusCapistranoCommand.cxx.

ResponseExpectedOff()

virtual void vtkPlusCapistranoCommand::ResponseExpectedOff ( )

virtual

ResponseExpectedOn()

virtual void vtkPlusCapistranoCommand::ResponseExpectedOn ( )

virtual

SafeDownCast()

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

static

SetCommandName()

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

protected

Definition at line 84 of file vtkPlusCapistranoCommand.cxx.

SetCommandValue()

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

protected

Definition at line 96 of file vtkPlusCapistranoCommand.cxx.

SetDeviceId()

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

virtual

Definition at line 72 of file vtkPlusCapistranoCommand.cxx.

SetResponseExpected()

virtual void vtkPlusCapistranoCommand::SetResponseExpected ( bool  )

virtual

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

WriteConfiguration()

PlusStatus vtkPlusCapistranoCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 144 of file vtkPlusCapistranoCommand.cxx.

Member Data Documentation

RequestedParameterChanges

std::list<std::pair<std::string, std::string> > vtkPlusCapistranoCommand::RequestedParameterChanges

protected

Definition at line 67 of file vtkPlusCapistranoCommand.h.

---

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

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