vtkPlusVersionCommand Class Reference

This command sends and receives version information to/from a client. More...

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

Inheritance diagram for vtkPlusVersionCommand:

Collaboration diagram for vtkPlusVersionCommand:

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 int	IsA (const char *type)
void	SetNameToVersion ()
Public Member Functions inherited from vtkPlusCommand
virtual int	GetClientId ()
virtual uint32_t	GetId ()
virtual bool	GetRespondWithCommandMessage ()
void	PopCommandResponses (PlusCommandResponseList &responses)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *aConfig)
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)
virtual PlusStatus	WriteConfiguration (vtkXMLDataElement *aConfig)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkPlusVersionCommand *	New ()
static vtkPlusVersionCommand *	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
	vtkPlusVersionCommand ()
virtual	~vtkPlusVersionCommand ()
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 sends and receives version information to/from a client.

Definition at line 19 of file vtkPlusVersionCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusVersionCommand::Superclass

Definition at line 24 of file vtkPlusVersionCommand.h.

Constructor & Destructor Documentation

vtkPlusVersionCommand()

vtkPlusVersionCommand::vtkPlusVersionCommand ( )

protected

Definition at line 20 of file vtkPlusVersionCommand.cxx.

~vtkPlusVersionCommand()

vtkPlusVersionCommand::~vtkPlusVersionCommand ( )

protectedvirtual

Definition at line 27 of file vtkPlusVersionCommand.cxx.

Member Function Documentation

Clone()

virtual vtkPlusCommand* vtkPlusVersionCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 25 of file vtkPlusVersionCommand.h.

Execute()

PlusStatus vtkPlusVersionCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 58 of file vtkPlusVersionCommand.cxx.

GetClassName()

virtual const char* vtkPlusVersionCommand::GetClassName ( )

virtual

GetCommandNames()

void vtkPlusVersionCommand::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 vtkPlusVersionCommand.cxx.

GetDescription()

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

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 46 of file vtkPlusVersionCommand.cxx.

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusVersionCommand* vtkPlusVersionCommand::New ( )

static

SafeDownCast()

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

static

SetNameToVersion()

void vtkPlusVersionCommand::SetNameToVersion

(

)

Definition at line 33 of file vtkPlusVersionCommand.cxx.

---

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

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