mtsCommandBase Class Reference

#include <mtsCommandBase.h>

Inheritance diagram for mtsCommandBase:

Public Member Functions
	mtsCommandBase (void)
	mtsCommandBase (const std::string &name)
virtual	~mtsCommandBase ()
virtual std::string	ToString (void) const
virtual void	ToStream (std::ostream &outputStream) const =0
virtual size_t	NumberOfArguments (void) const =0
virtual bool	Returns (void) const =0
void	Enable (void)
void	Disable (void)
bool	IsEnabled (void) const
bool	IsDisabled (void) const
const std::string &	GetName (void) const

Protected Attributes
std::string	Name
bool	EnableFlag

Constructor & Destructor Documentation

mtsCommandBase() [1/2]

mtsCommandBase::mtsCommandBase ( void )

inline

The constructor. Does nothing

mtsCommandBase() [2/2]

mtsCommandBase::mtsCommandBase ( const std::string & name )

inline

Constructor with command name.

~mtsCommandBase()

virtual mtsCommandBase::~mtsCommandBase ( )

inlinevirtual

The destructor. Does nothing

Member Function Documentation

Disable()

void mtsCommandBase::Disable ( void )

inline

Enable()

void mtsCommandBase::Enable ( void )

inline

Set and access the "enable" flag. This flag is used to determine if the command actually uses the provided method or function when it is executed.

GetName()

const std::string & mtsCommandBase::GetName ( void ) const

inline

Get the command name. This method doesn't allow to change the command name.

IsDisabled()

bool mtsCommandBase::IsDisabled ( void ) const

inline

IsEnabled()

bool mtsCommandBase::IsEnabled ( void ) const

inline

NumberOfArguments()

virtual size_t mtsCommandBase::NumberOfArguments ( void ) const

pure virtual

Returns number of arguments (parameters) expected by Execute method. Must be overloaded in derived classes.

Implemented in mtsCommandQualifiedRead, mtsCommandRead, mtsCommandVoid, mtsCommandVoidReturn, mtsCommandWriteBase, and mtsCommandWriteReturn.

Returns()

virtual bool mtsCommandBase::Returns ( void ) const

pure virtual

Implemented in mtsCommandQualifiedRead, mtsCommandRead, mtsCommandVoid, mtsCommandVoidReturn, mtsCommandWriteBase, and mtsCommandWriteReturn.

ToStream()

virtual void mtsCommandBase::ToStream ( std::ostream & outputStream ) const

pure virtual

Implemented in mtsCommandFilteredWrite, mtsCommandQualifiedRead, mtsCommandQueuedVoid, mtsCommandQueuedVoidReturnBase< mtsCommandRead >, mtsCommandQueuedVoidReturnBase< mtsCommandVoidReturn >, mtsCommandQueuedWriteBase, mtsCommandQueuedWriteGeneric, mtsCommandQueuedWriteReturnBase< mtsCommandQualifiedRead >, mtsCommandQueuedWriteReturnBase< mtsCommandWriteReturn >, mtsCommandRead, mtsCommandVoid, mtsCommandVoidReturn, mtsCommandWrite< _classType, _argumentType >, mtsCommandWrite< ClassType, ArgumentType >, mtsCommandWriteGeneric< _classType >, mtsCommandWriteGeneric< ClassType >, mtsCommandWriteReturn, mtsMulticastCommandVoid, and mtsMulticastCommandWriteBase.

ToString()

virtual std::string mtsCommandBase::ToString ( void ) const

inlinevirtual

For debugging. Generate a human readable output for the command object

Member Data Documentation

EnableFlag

bool mtsCommandBase::EnableFlag

protected

Flag used to determine is the command actually executes the provided method or function. This "gated" command can be useful to turn on/off and event callback or to prevent calling a method owned by an object being deleted.

Name

std::string mtsCommandBase::Name

protected

Name used for the command. The name is provided to the constructor and can be accessed using the method GetName().

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsCommandBase.h