vtkPlusRequestIdsCommand Class Reference

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

Inheritance diagram for vtkPlusRequestIdsCommand:

Collaboration diagram for vtkPlusRequestIdsCommand:

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)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *aConfig)
void	SetNameToRequestChannelIds ()
void	SetNameToRequestDeviceChannelIds ()
void	SetNameToRequestDeviceIds ()
void	SetNameToRequestInputDeviceIds ()
	vtkGetStdStringMacro (DeviceType)
	vtkGetStdStringMacro (DeviceId)
	vtkSetStdStringMacro (DeviceType)
	vtkSetStdStringMacro (DeviceId)
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 vtkPlusRequestIdsCommand *	New ()
static vtkPlusRequestIdsCommand *	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
	vtkPlusRequestIdsCommand ()
virtual	~vtkPlusRequestIdsCommand ()
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::string	DeviceId
std::string	DeviceType
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

Definition at line 19 of file vtkPlusRequestIdsCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusRequestIdsCommand::Superclass

Definition at line 24 of file vtkPlusRequestIdsCommand.h.

Constructor & Destructor Documentation

vtkPlusRequestIdsCommand()

vtkPlusRequestIdsCommand::vtkPlusRequestIdsCommand ( )

protected

Definition at line 28 of file vtkPlusRequestIdsCommand.cxx.

~vtkPlusRequestIdsCommand()

vtkPlusRequestIdsCommand::~vtkPlusRequestIdsCommand ( )

protectedvirtual

Definition at line 33 of file vtkPlusRequestIdsCommand.cxx.

Member Function Documentation

Clone()

virtual vtkPlusCommand* vtkPlusRequestIdsCommand::Clone ( )

inlinevirtual

Implements vtkPlusCommand.

Definition at line 26 of file vtkPlusRequestIdsCommand.h.

Execute()

PlusStatus vtkPlusRequestIdsCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 123 of file vtkPlusRequestIdsCommand.cxx.

GetClassName()

virtual const char* vtkPlusRequestIdsCommand::GetClassName ( )

virtual

GetCommandNames()

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

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 56 of file vtkPlusRequestIdsCommand.cxx.

GetDescription()

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

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 66 of file vtkPlusRequestIdsCommand.cxx.

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusRequestIdsCommand* vtkPlusRequestIdsCommand::New ( )

static

PrintSelf()

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

virtual

Reimplemented from vtkPlusCommand.

Definition at line 93 of file vtkPlusRequestIdsCommand.cxx.

ReadConfiguration()

PlusStatus vtkPlusRequestIdsCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 99 of file vtkPlusRequestIdsCommand.cxx.

SafeDownCast()

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

static

SetNameToRequestChannelIds()

void vtkPlusRequestIdsCommand::SetNameToRequestChannelIds

(

)

Definition at line 38 of file vtkPlusRequestIdsCommand.cxx.

SetNameToRequestDeviceChannelIds()

void vtkPlusRequestIdsCommand::SetNameToRequestDeviceChannelIds

(

)

Definition at line 50 of file vtkPlusRequestIdsCommand.cxx.

SetNameToRequestDeviceIds()

void vtkPlusRequestIdsCommand::SetNameToRequestDeviceIds

(

)

Definition at line 42 of file vtkPlusRequestIdsCommand.cxx.

SetNameToRequestInputDeviceIds()

void vtkPlusRequestIdsCommand::SetNameToRequestInputDeviceIds

(

)

Definition at line 46 of file vtkPlusRequestIdsCommand.cxx.

vtkGetStdStringMacro() [1/2]

vtkPlusRequestIdsCommand::vtkGetStdStringMacro

(

DeviceType

)

Restrict the returned device IDs to this type

vtkGetStdStringMacro() [2/2]

vtkPlusRequestIdsCommand::vtkGetStdStringMacro

(

DeviceId

)

vtkSetStdStringMacro() [1/2]

vtkPlusRequestIdsCommand::vtkSetStdStringMacro

(

DeviceType

)

vtkSetStdStringMacro() [2/2]

vtkPlusRequestIdsCommand::vtkSetStdStringMacro

(

DeviceId

)

WriteConfiguration()

PlusStatus vtkPlusRequestIdsCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 111 of file vtkPlusRequestIdsCommand.cxx.

Member Data Documentation

DeviceId

std::string vtkPlusRequestIdsCommand::DeviceId

protected

Definition at line 61 of file vtkPlusRequestIdsCommand.h.

DeviceType

std::string vtkPlusRequestIdsCommand::DeviceType

protected

Definition at line 60 of file vtkPlusRequestIdsCommand.h.

---

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

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