RTT::scripting::CommandCounter Class Reference

This command increments a counter when executed. More...

#include <CommandCounter.hpp>

Inheritance diagram for RTT::scripting::CommandCounter:

[legend]

List of all members.

Public Member Functions
virtual base::ActionInterface *	clone () const
virtual base::ActionInterface *	clone () const
	CommandCounter ()
	CommandCounter ()
virtual bool	execute ()
virtual bool	execute ()
virtual int	getCounter ()
virtual int	getCounter ()
virtual void	readArguments ()
virtual void	readArguments ()
virtual void	reset ()
virtual void	reset ()
virtual	~CommandCounter ()
virtual	~CommandCounter ()
Private Attributes
int	counter

---

Detailed Description

This command increments a counter when executed.

Deprecated:

Remove this low-level class since it's nowhere used.

Deprecated:

Remove this low-level class since it's nowhere used.

Definition at line 52 of file install/include/rtt/scripting/CommandCounter.hpp.

---

Constructor & Destructor Documentation

RTT::CommandCounter::CommandCounter

(

)

Definition at line 41 of file CommandCounter.cpp.

RTT::CommandCounter::~CommandCounter

(

)

[virtual]

Definition at line 46 of file CommandCounter.cpp.

RTT::scripting::CommandCounter::CommandCounter

(

)

virtual RTT::scripting::CommandCounter::~CommandCounter

(

)

[virtual]

---

Member Function Documentation

virtual base::ActionInterface* RTT::scripting::CommandCounter::clone

(

)

const [inline, virtual]

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 77 of file rtt/scripting/CommandCounter.hpp.

virtual base::ActionInterface* RTT::scripting::CommandCounter::clone

(

)

const [inline, virtual]

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 77 of file install/include/rtt/scripting/CommandCounter.hpp.

virtual bool RTT::scripting::CommandCounter::execute

(

)

[virtual]

Execute the functionality of this action.

Returns:

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

bool RTT::CommandCounter::execute

(

)

[virtual]

Execute the functionality of this action.

Returns:

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 53 of file CommandCounter.cpp.

virtual int RTT::scripting::CommandCounter::getCounter

(

)

[virtual]

return the number of times this command has been executed since the last reset

int RTT::CommandCounter::getCounter

(

)

[virtual]

return the number of times this command has been executed since the last reset

Definition at line 64 of file CommandCounter.cpp.

virtual void RTT::scripting::CommandCounter::readArguments

(

)

[virtual]

This is invoked some time before execute() at a time when the action may read its function arguments.

Implements RTT::base::ActionInterface.

void RTT::CommandCounter::readArguments

(

)

[virtual]

This is invoked some time before execute() at a time when the action may read its function arguments.

Implements RTT::base::ActionInterface.

Definition at line 50 of file CommandCounter.cpp.

virtual void RTT::scripting::CommandCounter::reset

(

)

[virtual]

set number of times executed to zero

Reimplemented from RTT::base::ActionInterface.

void RTT::CommandCounter::reset

(

)

[virtual]

set number of times executed to zero

Reimplemented from RTT::base::ActionInterface.

Definition at line 59 of file CommandCounter.cpp.

---

Member Data Documentation

int RTT::scripting::CommandCounter::counter [private]

Definition at line 83 of file install/include/rtt/scripting/CommandCounter.hpp.

---

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

• install/include/rtt/scripting/CommandCounter.hpp
• rtt/scripting/CommandCounter.hpp
• CommandCounter.cpp