ERC CISST - cisst software

---

mtsCallableVoidFunction Class Reference
[Multi Task Support]

#include <mtsCallableVoidFunction.h>

Inheritance diagram for mtsCallableVoidFunction:

[legend]Collaboration diagram for mtsCallableVoidFunction:

[legend]List of all members.

---

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.

Definition at line 36 of file mtsCallableVoidFunction.h.

Public Types

• typedef mtsCallableVoidBase BaseType
• typedef mtsCallableVoidFunction ThisType
• typedef void(*) ActionType (void)

Public Member Functions

• mtsCallableVoidFunction ()
• mtsCallableVoidFunction (ActionType action)
• virtual ~mtsCallableVoidFunction ()
• void Execute (void)
• void ToStream (std::ostream &outputStream) const

Protected Attributes

• ActionType Action

---

Member Typedef Documentation

typedef mtsCallableVoidFunction mtsCallableVoidFunction::ThisType

This type.

Definition at line 42 of file mtsCallableVoidFunction.h.

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

Typedef for pointer to member function

Definition at line 45 of file mtsCallableVoidFunction.h.

---

Constructor & Destructor Documentation

mtsCallableVoidFunction::mtsCallableVoidFunction

(

)

[inline]

The constructor. Does nothing

Definition at line 57 of file mtsCallableVoidFunction.h.

mtsCallableVoidFunction::mtsCallableVoidFunction

(

ActionType

action

)

[inline]

The constructor.

Parameters:

action

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

Definition at line 63 of file mtsCallableVoidFunction.h.

virtual mtsCallableVoidFunction::~mtsCallableVoidFunction

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 69 of file mtsCallableVoidFunction.h.

---

Member Function Documentation

void mtsCallableVoidFunction::Execute

(

void

)

[inline, virtual]

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

Implements mtsCallableVoidBase.

Definition at line 72 of file mtsCallableVoidFunction.h.

void mtsCallableVoidFunction::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

Human readable description

Implements mtsCallableVoidBase.

Definition at line 77 of file mtsCallableVoidFunction.h.

---

Member Data Documentation

ActionType mtsCallableVoidFunction::Action [protected]

The pointer to function used when the command is executed.

Definition at line 53 of file mtsCallableVoidFunction.h.

---

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

• mtsCallableVoidFunction.h

---