vtkPlusUpdateTransformCommand Class Reference

This command updates the value of a transformation in the transform repository. More...

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

Inheritance diagram for vtkPlusUpdateTransformCommand:

Collaboration diagram for vtkPlusUpdateTransformCommand:

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 double	GetTransformError ()
virtual bool	GetTransformPersistent ()
virtual vtkMatrix4x4 *	GetTransformValue ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *aConfig)
void	SetNameToUpdateTransform ()
void	SetTransformError (double _arg)
void	SetTransformPersistent (bool _arg)
virtual void	SetTransformValue (vtkMatrix4x4 *)
void	SetTransformValue (double *matrixElements)
	vtkGetStdStringMacro (TransformName)
	vtkGetStdStringMacro (TransformDate)
	vtkSetStdStringMacro (TransformName)
	vtkSetStdStringMacro (TransformDate)
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 vtkPlusUpdateTransformCommand *	New ()
static vtkPlusUpdateTransformCommand *	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
	vtkPlusUpdateTransformCommand ()
virtual	~vtkPlusUpdateTransformCommand ()
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 updates the value of a transformation in the transform repository.

Definition at line 20 of file vtkPlusUpdateTransformCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusUpdateTransformCommand::Superclass

Definition at line 25 of file vtkPlusUpdateTransformCommand.h.

Constructor & Destructor Documentation

vtkPlusUpdateTransformCommand()

vtkPlusUpdateTransformCommand::vtkPlusUpdateTransformCommand ( )

protected

Definition at line 22 of file vtkPlusUpdateTransformCommand.cxx.

~vtkPlusUpdateTransformCommand()

vtkPlusUpdateTransformCommand::~vtkPlusUpdateTransformCommand ( )

protectedvirtual

Definition at line 30 of file vtkPlusUpdateTransformCommand.cxx.

Member Function Documentation

Clone()

virtual vtkPlusCommand* vtkPlusUpdateTransformCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 27 of file vtkPlusUpdateTransformCommand.h.

Execute()

PlusStatus vtkPlusUpdateTransformCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 111 of file vtkPlusUpdateTransformCommand.cxx.

GetClassName()

virtual const char* vtkPlusUpdateTransformCommand::GetClassName ( )

virtual

GetCommandNames()

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

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 42 of file vtkPlusUpdateTransformCommand.cxx.

GetDescription()

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

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 49 of file vtkPlusUpdateTransformCommand.cxx.

GetTransformError()

virtual double vtkPlusUpdateTransformCommand::GetTransformError ( )

virtual

GetTransformPersistent()

virtual bool vtkPlusUpdateTransformCommand::GetTransformPersistent ( )

virtual

GetTransformValue()

virtual vtkMatrix4x4* vtkPlusUpdateTransformCommand::GetTransformValue ( )

virtual

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusUpdateTransformCommand* vtkPlusUpdateTransformCommand::New ( )

static

PrintSelf()

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

virtual

Reimplemented from vtkPlusCommand.

Definition at line 61 of file vtkPlusUpdateTransformCommand.cxx.

ReadConfiguration()

PlusStatus vtkPlusUpdateTransformCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 67 of file vtkPlusUpdateTransformCommand.cxx.

SafeDownCast()

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

static

SetNameToUpdateTransform()

void vtkPlusUpdateTransformCommand::SetNameToUpdateTransform

(

)

Definition at line 36 of file vtkPlusUpdateTransformCommand.cxx.

SetTransformError()

void vtkPlusUpdateTransformCommand::SetTransformError ( double  _arg )

inline

Definition at line 55 of file vtkPlusUpdateTransformCommand.h.

SetTransformPersistent()

void vtkPlusUpdateTransformCommand::SetTransformPersistent ( bool  _arg )

inline

Definition at line 58 of file vtkPlusUpdateTransformCommand.h.

SetTransformValue() [1/2]

virtual void vtkPlusUpdateTransformCommand::SetTransformValue ( vtkMatrix4x4 *  )

virtual

SetTransformValue() [2/2]

void vtkPlusUpdateTransformCommand::SetTransformValue

(

double *

matrixElements

)

Definition at line 162 of file vtkPlusUpdateTransformCommand.cxx.

vtkGetStdStringMacro() [1/2]

vtkPlusUpdateTransformCommand::vtkGetStdStringMacro

(

TransformName

)

vtkGetStdStringMacro() [2/2]

vtkPlusUpdateTransformCommand::vtkGetStdStringMacro

(

TransformDate

)

vtkSetStdStringMacro() [1/2]

vtkPlusUpdateTransformCommand::vtkSetStdStringMacro

(

TransformName

)

vtkSetStdStringMacro() [2/2]

vtkPlusUpdateTransformCommand::vtkSetStdStringMacro

(

TransformDate

)

WriteConfiguration()

PlusStatus vtkPlusUpdateTransformCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 82 of file vtkPlusUpdateTransformCommand.cxx.

---

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

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