RTT::extras::SimulationActivity Class Reference
[Activity (thread) classes.]

A SimulationActivity is a PeriodicActivity which is used for simulation. More...

#include <SimulationActivity.hpp>

Inheritance diagram for RTT::extras::SimulationActivity:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool execute ()
virtual bool execute ()
 SimulationActivity (secs s, nsecs ns, base::RunnableInterface *r=0)
 SimulationActivity (Seconds period, base::RunnableInterface *r=0)
 SimulationActivity (secs s, nsecs ns, base::RunnableInterface *r=0)
 SimulationActivity (Seconds period, base::RunnableInterface *r=0)
virtual bool start ()
virtual bool start ()
virtual os::ThreadInterfacethread ()
virtual os::ThreadInterfacethread ()
virtual ~SimulationActivity ()
virtual ~SimulationActivity ()

Detailed Description

A SimulationActivity is a PeriodicActivity which is used for simulation.

They all run in the same thread at the same period, which updates the the system clock such that the SimulationActivity appears to run in realtime, while it runs 'as fast as possible'.

Note:
The period is fixed by the SimulationThread, which runs all SimulationActivities at the same period.

Definition at line 59 of file install/include/rtt/extras/SimulationActivity.hpp.


Constructor & Destructor Documentation

RTT::SimulationActivity::SimulationActivity ( Seconds  period,
base::RunnableInterface r = 0 
)

Construct a SimulationActivity with a periodicity period Seconds

Note:
period is ignored.

Definition at line 45 of file SimulationActivity.cpp.

RTT::SimulationActivity::SimulationActivity ( secs  s,
nsecs  ns,
base::RunnableInterface r = 0 
)

Construct a SimulationActivity with a periodicity of s seconds and ns nanoseconds

Note:
s and ns are ignored.

Definition at line 50 of file SimulationActivity.cpp.

RTT::SimulationActivity::~SimulationActivity (  )  [virtual]

Destroys this instance. The Activity is stopped.

Definition at line 55 of file SimulationActivity.cpp.

RTT::extras::SimulationActivity::SimulationActivity ( Seconds  period,
base::RunnableInterface r = 0 
)

Construct a SimulationActivity with a periodicity period Seconds

Note:
period is ignored.
RTT::extras::SimulationActivity::SimulationActivity ( secs  s,
nsecs  ns,
base::RunnableInterface r = 0 
)

Construct a SimulationActivity with a periodicity of s seconds and ns nanoseconds

Note:
s and ns are ignored.
virtual RTT::extras::SimulationActivity::~SimulationActivity (  )  [virtual]

Destroys this instance. The Activity is stopped.


Member Function Documentation

virtual bool RTT::extras::SimulationActivity::execute (  )  [virtual]

When a SimulationActivity is started, it may be executed by the user as well.

Reimplemented from RTT::extras::PeriodicActivity.

bool RTT::SimulationActivity::execute (  )  [virtual]

When a SimulationActivity is started, it may be executed by the user as well.

Reimplemented from RTT::extras::PeriodicActivity.

Definition at line 64 of file SimulationActivity.cpp.

virtual bool RTT::extras::SimulationActivity::start (  )  [virtual]

A simulated activity can be started also if the SimulationThread is not running yet. This allows all tasks to be set ready in advance before the whole simulation is started.

Reimplemented from RTT::extras::PeriodicActivity.

bool RTT::SimulationActivity::start (  )  [virtual]

A simulated activity can be started also if the SimulationThread is not running yet. This allows all tasks to be set ready in advance before the whole simulation is started.

Reimplemented from RTT::extras::PeriodicActivity.

Definition at line 75 of file SimulationActivity.cpp.

virtual os::ThreadInterface* RTT::extras::SimulationActivity::thread (  )  [virtual]

Returns a pointer to the thread which will run this activity. Will not be null.

Reimplemented from RTT::extras::PeriodicActivity.

os::ThreadInterface * RTT::SimulationActivity::thread (  )  [virtual]

Returns a pointer to the thread which will run this activity. Will not be null.

Reimplemented from RTT::extras::PeriodicActivity.

Definition at line 60 of file SimulationActivity.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:49:56 2013