mtsCallableVoidFunction Class Reference

#include <mtsCallableVoidFunction.h>

Inheritance diagram for mtsCallableVoidFunction:

Public Types
typedef mtsCallableVoidBase	BaseType
typedef mtsCallableVoidFunction	ThisType
typedef void(*	ActionType )(void)

Public Member Functions
	mtsCallableVoidFunction ()
	mtsCallableVoidFunction (ActionType action)
virtual	~mtsCallableVoidFunction ()
mtsExecutionResult	Execute (void)
void	ToStream (std::ostream &outputStream) const
Public Member Functions inherited from mtsCallableVoidBase
	mtsCallableVoidBase (void)
virtual	~mtsCallableVoidBase ()

Protected Attributes
ActionType	Action

Detailed Description

A templated version of command object with zero arguments for execute. This command is based on a void function, i.e. it only requires a pointer on a void function.

Member Typedef Documentation

typedef void(* mtsCallableVoidFunction::ActionType)(void)

Typedef for pointer to member function

typedef mtsCallableVoidBase mtsCallableVoidFunction::BaseType

typedef mtsCallableVoidFunction mtsCallableVoidFunction::ThisType

This type.

Constructor & Destructor Documentation

mtsCallableVoidFunction::mtsCallableVoidFunction ( )

inline

The constructor. Does nothing

mtsCallableVoidFunction::mtsCallableVoidFunction ( ActionType  action )

inline

The constructor.

Parameters

action

Pointer to the function that is to be called by the invoker of the command

virtual mtsCallableVoidFunction::~mtsCallableVoidFunction ( )

inlinevirtual

The destructor. Does nothing

Member Function Documentation

mtsExecutionResult mtsCallableVoidFunction::Execute ( void  )

inlinevirtual

The execute method. Abstract method to be implemented by derived classes to run the actual operation on the receiver.

Implements mtsCallableVoidBase.

void mtsCallableVoidFunction::ToStream ( std::ostream &  outputStream ) const

inlinevirtual

Human readable description

Implements mtsCallableVoidBase.

Member Data Documentation

ActionType mtsCallableVoidFunction::Action

protected

The pointer to function used when the command is executed.

---

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

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsCallableVoidFunction.h