WorldController Class Reference
WorldController class. More...
Public Member Functions | |
| WorldController (World *world, QString name) | |
| Constructor. | |
| ~WorldController () | |
| Destructor. | |
| yarp::os::Port * | inPort () |
| return the input Port | |
| yarp::os::Port * | outPort () |
| return the output Port | |
| virtual void | update () |
| only when the update is called the commands sended to the WorldController are executed | |
Detailed Description
WorldController class.
\
- Motivation
- The WorldController class allow to manipulate the World using commands on YARP RPC ports.
- Description
- Warnings
- Only one WorldController for each World is allowed.
Definition at line 106 of file worldcontroller.h.
Constructor & Destructor Documentation
| WorldController | ( | World * | world, |
| QString | name | ||
| ) |
Constructor.
Definition at line 322 of file worldcontroller.cpp.
References WObject::name(), and WObject::world().
| ~WorldController | ( | ) |
Destructor.
Definition at line 333 of file worldcontroller.cpp.
Member Function Documentation
| yarp::os::Port* inPort | ( | ) | [inline] |
return the input Port
Definition at line 116 of file worldcontroller.h.
Referenced by ServerWorldController::run().
| yarp::os::Port* outPort | ( | ) | [inline] |
return the output Port
Definition at line 120 of file worldcontroller.h.
Referenced by ServerWorldController::applyQueuedCommands(), and ServerWorldController::run().
| void update | ( | ) | [virtual] |
only when the update is called the commands sended to the WorldController are executed
Definition at line 343 of file worldcontroller.cpp.
References ServerWorldController::applyQueuedCommands().
The documentation for this class was generated from the following files:
- worldsim/include/worldcontroller.h
- worldsim/src/worldcontroller.cpp