|
| bool | start () override |
| | Start (or resumes, if stopped) the currently selected action.
|
| |
| bool | stop () override |
| | Stops the currently selected (running) action.
|
| |
| bool | reset () override |
| | Rewinds the currently selected action.
|
| |
| bool | forever () override |
| | Similar to play, but it will automatically restart the playback when the last frame is reached.
|
| |
| bool | print_frames () override |
| | Prints all the frames of the currently selected action.
|
| |
| bool | speed_factor (const double value) override |
| | Sets the playback speed factor for the currently selected action (default value: 1.0).
|
| |
| bool | resample (const double value) override |
| | Resamples the currently selected action (in seconds, recommended value 0.010s).
|
| |
| bool | choose_action (const std::string &action_name) override |
| | Choose the current action and wait for further commands.
|
| |
| bool | play_action (const std::string &action_name) override |
| | Play an action one single time.
|
| |
| bool | show_actions () override |
| | Prints all the loaded actions.
|
| |
| bool | set_thread_period (const double value) override |
| | Sets the period of the sampling thread (for advanced use only, default value: 0.010s).
|
| |
| bool | set_initial_move_time (const double value) override |
| | Sets the uration for the initial homing movement (for advanced use only, default value: 2s).
|
| |
| | scriptModule () |
| |
| | ~scriptModule () |
| |
| bool | chooseActionByName (std::string id) |
| |
| std::string | string_list_actions () |
| |
| bool | loadConfiguration (std::string filename, double resample_period) |
| |
| void | print_help () |
| |
| virtual bool | configure (yarp::os::ResourceFinder &rf) |
| | Configure the module, pass a ResourceFinder object to the module.
|
| |
| virtual bool | close () |
| | Close function.
|
| |
| virtual double | getPeriod () |
| | You can override this to control the approximate periodicity at which updateModule() is called by runModule().
|
| |
| virtual bool | updateModule () |
| | Override this to do whatever your module needs to do.
|
| |
| | RFModule () |
| | Constructor.
|
| |
| virtual | ~RFModule () |
| | Destructor.
|
| |
| virtual int | runModule () |
| | Calls updateModule() until that returns false.
|
| |
| virtual int | runModule (yarp::os::ResourceFinder &rf) |
| | Simple helper method to call configure() and then runModule().
|
| |
| virtual int | runModuleThreaded () |
| | Calls updateModule() on a separate thread until that returns false.
|
| |
| virtual int | runModuleThreaded (yarp::os::ResourceFinder &rf) |
| | Simple helper method to call configure() and then runModule() on a separate thread.
|
| |
| virtual int | getThreadKey () |
| | return the Thread unique identifier
|
| |
| virtual bool | respond (const Bottle &command, Bottle &reply) |
| | Respond to a message.
|
| |
| virtual bool | attach (yarp::os::Port &source) |
| | Make any input from a Port object go to the respond() method.
|
| |
| virtual bool | attach (yarp::os::RpcServer &source) |
| | Make any input from an RpcServer object go to the respond() method.
|
| |
| bool | attachTerminal () |
| | Make any input from standard input (usually the keyboard) go to the respond() method.
|
| |
| bool | detachTerminal () |
| | Detach terminal.
|
| |
| virtual bool | interruptModule () |
| | Try to halt any ongoing operations by threads managed by the module.
|
| |
| void | stopModule (bool wait=false) |
| | Ask the module to stop.
|
| |
| bool | isStopping () |
| | Check if the module should stop.
|
| |
| bool | joinModule (double seconds=-1) |
| | The function returns when the thread execution has completed.
|
| |
| std::string | getName (const std::string &subName="") |
| | Return name of module, as set with setName().
|
| |
| void | setName (const char *name) |
| | Set the name of the module.
|
| |
| bool | safeRespond (const Bottle &command, Bottle &reply) |
| | Wrapper around respond() that is guaranteed to process system messages.
|
| |
| virtual yarp::os::ApplicationNetworkProtocolVersion | getLocalProtocolVersion () |
| |
| virtual yarp::os::ApplicationNetworkProtocolVersion | getRemoteProtocolVersion () |
| |
| virtual bool | checkProtocolVersion () |
| |
| | yarpActionsPlayer_IDL () |
| |
| virtual std::vector< std::string > | help (const std::string &functionName="--all") |
| |
| bool | read (yarp::os::ConnectionReader &connection) override |
| | Read this object from a network connection.
|
| |
| yarp::os::WireLink & | yarp () |
| | Get YARP state associated with this object.
|
| |
| const yarp::os::WireLink & | yarp () const |
| | Get YARP state associated with this object (const version).
|
| |
| virtual | ~PortReader () |
| | Destructor.
|
| |
| virtual Type | getReadType () const |
| |
Definition at line 31 of file main.cpp.
| virtual bool scriptModule::updateModule |
( |
| ) |
|
|
inlinevirtual |
Override this to do whatever your module needs to do.
When your module wants to stop, return false. The module's actual work could be done during this call, or it could just check the state of a thread running in the background.
The thread calls the updateModule() function every <period> seconds. At the end of each run, the thread will sleep the amounth of time required, taking into account the time spent inside the loop function. Example: requested period is 10ms, the updateModule() function take 3ms to be executed, the thread will sleep for 7ms.
Note: after each run is completed, the thread will call a yield() in order to facilitate other threads to run.
- Returns
- true iff module should continue
Implements yarp::os::RFModule.
Definition at line 389 of file main.cpp.
Inheritance diagram for scriptModule:
1.9.8 