vtkPlusStartStopRecordingCommand Class Reference

This command starts and stops capturing with a vtkPlusVirtualCapture capture on the server side. More...

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

Inheritance diagram for vtkPlusStartStopRecordingCommand:

Collaboration diagram for vtkPlusStartStopRecordingCommand:

Public Types
typedef vtkPlusCommand	Superclass

Public Member Functions
virtual vtkPlusCommand *	Clone ()
virtual PlusStatus	Execute ()
vtkPlusVirtualCapture *	GetCaptureDevice (const std::string &captureDeviceId)
virtual const char *	GetClassName ()
virtual void	GetCommandNames (std::list< std::string > &cmdNames)
virtual std::string	GetDescription (const std::string &commandName)
virtual bool	GetEnableCompression ()
vtkPlusVirtualCapture *	GetOrCreateCaptureDevice (const std::string &channelId)
virtual bool	GetPauseOnStart ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *aConfig)
virtual void	SetEnableCompression (bool)
void	SetNameToHeader ()
void	SetNameToResume ()
void	SetNameToStart ()
void	SetNameToStop ()
void	SetNameToSuspend ()
virtual void	SetPauseOnStart (bool)
	vtkGetStdStringMacro (OutputFilename)
	vtkGetStdStringMacro (CaptureDeviceId)
	vtkGetStdStringMacro (ChannelId)
	vtkGetStdStringMacro (CodecFourCC)
	vtkSetStdStringMacro (OutputFilename)
	vtkSetStdStringMacro (CaptureDeviceId)
	vtkSetStdStringMacro (ChannelId)
	vtkSetStdStringMacro (CodecFourCC)
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 vtkPlusStartStopRecordingCommand *	New ()
static vtkPlusStartStopRecordingCommand *	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
	vtkPlusStartStopRecordingCommand ()
virtual	~vtkPlusStartStopRecordingCommand ()
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 starts and stops capturing with a vtkPlusVirtualCapture capture on the server side.

Definition at line 22 of file vtkPlusStartStopRecordingCommand.h.

Member Typedef Documentation

Superclass

typedef vtkPlusCommand vtkPlusStartStopRecordingCommand::Superclass

Definition at line 27 of file vtkPlusStartStopRecordingCommand.h.

Constructor & Destructor Documentation

vtkPlusStartStopRecordingCommand()

vtkPlusStartStopRecordingCommand::vtkPlusStartStopRecordingCommand ( )

protected

Definition at line 32 of file vtkPlusStartStopRecordingCommand.cxx.

~vtkPlusStartStopRecordingCommand()

vtkPlusStartStopRecordingCommand::~vtkPlusStartStopRecordingCommand ( )

protectedvirtual

Definition at line 39 of file vtkPlusStartStopRecordingCommand.cxx.

Member Function Documentation

Clone()

vtkPlusCommand * vtkPlusStartStopRecordingCommand::Clone ( )

virtual

Implements vtkPlusCommand.

Definition at line 103 of file vtkPlusStartStopRecordingCommand.cxx.

Execute()

PlusStatus vtkPlusStartStopRecordingCommand::Execute ( )

virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 301 of file vtkPlusStartStopRecordingCommand.cxx.

GetCaptureDevice()

vtkPlusVirtualCapture * vtkPlusStartStopRecordingCommand::GetCaptureDevice

(

const std::string &

captureDeviceId

)

Helper function to get pointer to the capture device

Parameters

captureDeviceId

Capture device ID. If it is NULL then a pointer to the first VirtualStreamCapture device is returned.

Definition at line 183 of file vtkPlusStartStopRecordingCommand.cxx.

GetClassName()

virtual const char* vtkPlusStartStopRecordingCommand::GetClassName ( )

virtual

GetCommandNames()

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

virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 51 of file vtkPlusStartStopRecordingCommand.cxx.

GetDescription()

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

virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 62 of file vtkPlusStartStopRecordingCommand.cxx.

GetEnableCompression()

virtual bool vtkPlusStartStopRecordingCommand::GetEnableCompression ( )

virtual

GetOrCreateCaptureDevice()

vtkPlusVirtualCapture * vtkPlusStartStopRecordingCommand::GetOrCreateCaptureDevice

(

const std::string &

channelId

)

Helper function to get pointer to the capture device

Parameters

captureDeviceId

Capture device ID. If it is NULL then a pointer to the first VirtualStreamCapture device is returned.

Definition at line 232 of file vtkPlusStartStopRecordingCommand.cxx.

GetPauseOnStart()

virtual bool vtkPlusStartStopRecordingCommand::GetPauseOnStart ( )

virtual

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusStartStopRecordingCommand* vtkPlusStartStopRecordingCommand::New ( )

static

PrintSelf()

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

virtual

Reimplemented from vtkPlusCommand.

Definition at line 97 of file vtkPlusStartStopRecordingCommand.cxx.

ReadConfiguration()

PlusStatus vtkPlusStartStopRecordingCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 109 of file vtkPlusStartStopRecordingCommand.cxx.

SafeDownCast()

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

static

SetEnableCompression()

virtual void vtkPlusStartStopRecordingCommand::SetEnableCompression ( bool  )

virtual

SetNameToHeader()

void vtkPlusStartStopRecordingCommand::SetNameToHeader

(

)

Definition at line 48 of file vtkPlusStartStopRecordingCommand.cxx.

SetNameToResume()

void vtkPlusStartStopRecordingCommand::SetNameToResume

(

)

Definition at line 46 of file vtkPlusStartStopRecordingCommand.cxx.

SetNameToStart()

void vtkPlusStartStopRecordingCommand::SetNameToStart

(

)

Definition at line 44 of file vtkPlusStartStopRecordingCommand.cxx.

SetNameToStop()

void vtkPlusStartStopRecordingCommand::SetNameToStop

(

)

Definition at line 47 of file vtkPlusStartStopRecordingCommand.cxx.

SetNameToSuspend()

void vtkPlusStartStopRecordingCommand::SetNameToSuspend

(

)

Definition at line 45 of file vtkPlusStartStopRecordingCommand.cxx.

SetPauseOnStart()

virtual void vtkPlusStartStopRecordingCommand::SetPauseOnStart ( bool  )

virtual

vtkGetStdStringMacro() [1/4]

vtkPlusStartStopRecordingCommand::vtkGetStdStringMacro

(

OutputFilename

)

vtkGetStdStringMacro() [2/4]

vtkPlusStartStopRecordingCommand::vtkGetStdStringMacro

(

CaptureDeviceId

)

vtkGetStdStringMacro() [3/4]

vtkPlusStartStopRecordingCommand::vtkGetStdStringMacro

(

ChannelId

)

vtkGetStdStringMacro() [4/4]

vtkPlusStartStopRecordingCommand::vtkGetStdStringMacro

(

CodecFourCC

)

vtkSetStdStringMacro() [1/4]

vtkPlusStartStopRecordingCommand::vtkSetStdStringMacro

(

OutputFilename

)

vtkSetStdStringMacro() [2/4]

vtkPlusStartStopRecordingCommand::vtkSetStdStringMacro

(

CaptureDeviceId

)

vtkSetStdStringMacro() [3/4]

vtkPlusStartStopRecordingCommand::vtkSetStdStringMacro

(

ChannelId

)

vtkSetStdStringMacro() [4/4]

vtkPlusStartStopRecordingCommand::vtkSetStdStringMacro

(

CodecFourCC

)

WriteConfiguration()

PlusStatus vtkPlusStartStopRecordingCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig )

virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 163 of file vtkPlusStartStopRecordingCommand.cxx.

---

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

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