PlusLib  2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkPlusGetFrameRateCommand Class Reference

This command returns the current frame rate from a vtkPlusChannel's DataSource.This command is used for communicating with a vtkPlusChannel. More...

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

Inheritance diagram for vtkPlusGetFrameRateCommand:
Inheritance graph
[legend]
Collaboration diagram for vtkPlusGetFrameRateCommand:
Collaboration graph
[legend]

Public Types

typedef vtkPlusCommand Superclass
 

Public Member Functions

virtual vtkPlusCommandClone ()
 
virtual PlusStatus Execute ()
 
virtual std::string GetChannelId () const
 
virtual const char * GetClassName ()
 
virtual void GetCommandNames (std::list< std::string > &cmdNames)
 
virtual std::string GetDescription (const std::string &commandName)
 
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 SetChannelId (const std::string &channelId)
 
void SetNameToGetFrameRate ()
 
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 vtkPlusGetFrameRateCommandNew ()
 
static vtkPlusGetFrameRateCommandSafeDownCast (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

 vtkPlusGetFrameRateCommand ()
 
virtual ~vtkPlusGetFrameRateCommand ()
 
- Protected Member Functions inherited from vtkPlusCommand
virtual vtkPlusDataCollectorGetDataCollector ()
 
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
 
vtkPlusCommandProcessorCommandProcessor
 
PlusCommandResponseList CommandResponseQueue
 
std::string DeviceName
 
uint32_t Id
 
igtl::MessageBase::MetaDataMap MetaData
 
std::string Name
 
bool RespondWithCommandMessage
 

Detailed Description

This command returns the current frame rate from a vtkPlusChannel's DataSource.

This command is used for communicating with a vtkPlusChannel.

Definition at line 23 of file vtkPlusGetFrameRateCommand.h.

Member Typedef Documentation

◆ Superclass

Definition at line 28 of file vtkPlusGetFrameRateCommand.h.

Constructor & Destructor Documentation

◆ vtkPlusGetFrameRateCommand()

vtkPlusGetFrameRateCommand::vtkPlusGetFrameRateCommand ( )
protected

Definition at line 22 of file vtkPlusGetFrameRateCommand.cxx.

◆ ~vtkPlusGetFrameRateCommand()

vtkPlusGetFrameRateCommand::~vtkPlusGetFrameRateCommand ( )
protectedvirtual

Definition at line 30 of file vtkPlusGetFrameRateCommand.cxx.

Member Function Documentation

◆ Clone()

virtual vtkPlusCommand* vtkPlusGetFrameRateCommand::Clone ( )
inlinevirtual

Implements vtkPlusCommand.

Definition at line 30 of file vtkPlusGetFrameRateCommand.h.

◆ Execute()

PlusStatus vtkPlusGetFrameRateCommand::Execute ( )
virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 100 of file vtkPlusGetFrameRateCommand.cxx.

◆ GetChannelId()

std::string vtkPlusGetFrameRateCommand::GetChannelId ( ) const
virtual

Id of the channel to pull frame rate information from.

Definition at line 60 of file vtkPlusGetFrameRateCommand.cxx.

◆ GetClassName()

virtual const char* vtkPlusGetFrameRateCommand::GetClassName ( )
virtual

◆ GetCommandNames()

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

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 41 of file vtkPlusGetFrameRateCommand.cxx.

◆ GetDescription()

std::string vtkPlusGetFrameRateCommand::GetDescription ( const std::string &  commandName)
virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 48 of file vtkPlusGetFrameRateCommand.cxx.

◆ GetResponseExpected()

virtual bool vtkPlusGetFrameRateCommand::GetResponseExpected ( )
virtual

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkPlusGetFrameRateCommand* vtkPlusGetFrameRateCommand::New ( )
static

◆ PrintSelf()

void vtkPlusGetFrameRateCommand::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkPlusCommand.

Definition at line 72 of file vtkPlusGetFrameRateCommand.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusGetFrameRateCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig)
virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 78 of file vtkPlusGetFrameRateCommand.cxx.

◆ ResponseExpectedOff()

virtual void vtkPlusGetFrameRateCommand::ResponseExpectedOff ( )
virtual

◆ ResponseExpectedOn()

virtual void vtkPlusGetFrameRateCommand::ResponseExpectedOn ( )
virtual

◆ SafeDownCast()

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

◆ SetChannelId()

void vtkPlusGetFrameRateCommand::SetChannelId ( const std::string &  channelId)
virtual

Definition at line 66 of file vtkPlusGetFrameRateCommand.cxx.

◆ SetNameToGetFrameRate()

void vtkPlusGetFrameRateCommand::SetNameToGetFrameRate ( )

Definition at line 35 of file vtkPlusGetFrameRateCommand.cxx.

◆ SetResponseExpected()

virtual void vtkPlusGetFrameRateCommand::SetResponseExpected ( bool  )
virtual

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

◆ WriteConfiguration()

PlusStatus vtkPlusGetFrameRateCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig)
virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 89 of file vtkPlusGetFrameRateCommand.cxx.


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