JoypadControlServer
: joypad input network wrapper on server side
More...
#include <networkWrappers/JoypadControlServer/JoypadControlServer.h>
Public Member Functions | |
JoypadControlServer () | |
JoypadControlServer (const JoypadControlServer &)=delete | |
JoypadControlServer (JoypadControlServer &&)=delete | |
JoypadControlServer & | operator= (const JoypadControlServer &)=delete |
JoypadControlServer & | operator= (JoypadControlServer &&)=delete |
~JoypadControlServer () override | |
bool | open (yarp::os::Searchable ¶ms) override |
Open the DeviceDriver. | |
bool | close () override |
Close the DeviceDriver. | |
bool | attach (yarp::dev::PolyDriver *poly) override |
Attach to another object. | |
bool | detach () override |
Detach the object (you must have first called attach). | |
bool | threadInit () override |
Initialization method. | |
void | threadRelease () override |
Release method. | |
void | run () override |
Loop function. | |
Public Member Functions inherited from yarp::dev::DeviceDriver | |
DeviceDriver () | |
DeviceDriver (const DeviceDriver &other)=delete | |
DeviceDriver (DeviceDriver &&other) noexcept=delete | |
DeviceDriver & | operator= (const DeviceDriver &other)=delete |
DeviceDriver & | operator= (DeviceDriver &&other) noexcept=delete |
virtual | ~DeviceDriver () |
virtual std::string | id () const |
Return the id assigned to the PolyDriver. | |
virtual void | setId (const std::string &id) |
Set the id for this device. | |
template<class T > | |
bool | view (T *&x) |
Get an interface to the device driver. | |
virtual DeviceDriver * | getImplementation () |
Some drivers are bureaucrats, pointing at others. | |
Public Member Functions inherited from yarp::dev::WrapperSingle | |
~WrapperSingle () override | |
Destructor. | |
bool | attachAll (const yarp::dev::PolyDriverList &drivers) final |
Attach to a list of objects. | |
bool | detachAll () final |
Detach the object (you must have first called attach). | |
Public Member Functions inherited from yarp::dev::IWrapper | |
virtual | ~IWrapper () |
Destructor. | |
Public Member Functions inherited from yarp::dev::IMultipleWrapper | |
virtual | ~IMultipleWrapper () |
Destructor. | |
Public Member Functions inherited from yarp::os::PeriodicThread | |
PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative) | |
Constructor. | |
PeriodicThread (double period, PeriodicThreadClock clockAccuracy) | |
Constructor. | |
virtual | ~PeriodicThread () |
bool | start () |
Call this to start the thread. | |
void | step () |
Call this to "step" the thread rather than starting it. | |
void | stop () |
Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called). | |
void | askToStop () |
Stop the thread. | |
bool | isRunning () const |
Returns true when the thread is started, false otherwise. | |
bool | isSuspended () const |
Returns true when the thread is suspended, false otherwise. | |
bool | setPeriod (double period) |
Set the (new) period of the thread. | |
double | getPeriod () const |
Return the current period of the thread. | |
void | suspend () |
Suspend the thread, the thread keeps running by doLoop is never executed. | |
void | resume () |
Resume the thread if previously suspended. | |
void | resetStat () |
Reset thread statistics. | |
double | getEstimatedPeriod () const |
Return estimated period since last reset. | |
void | getEstimatedPeriod (double &av, double &std) const |
Return estimated period since last reset. | |
unsigned int | getIterations () const |
Return the number of iterations performed since last reset. | |
double | getEstimatedUsed () const |
Return the estimated duration of the run() function since last reset. | |
void | getEstimatedUsed (double &av, double &std) const |
Return estimated duration of the run() function since last reset. | |
int | setPriority (int priority, int policy=-1) |
Set the priority and scheduling policy of the thread, if the OS supports that. | |
int | getPriority () const |
Query the current priority of the thread, if the OS supports that. | |
int | getPolicy () const |
Query the current scheduling policy of the thread, if the OS supports that. | |
Public Member Functions inherited from JoypadControlServer_ParamsParser | |
JoypadControlServer_ParamsParser () | |
~JoypadControlServer_ParamsParser () override=default | |
bool | parseParams (const yarp::os::Searchable &config) override |
Parse the DeviceDriver parameters. | |
std::string | getDeviceClassName () const override |
Get the name of the DeviceDriver class. | |
std::string | getDeviceName () const override |
Get the name of the device (i.e. | |
std::string | getDocumentationOfDeviceParams () const override |
Get the documentation of the DeviceDriver's parameters. | |
std::vector< std::string > | getListOfParams () const override |
Return a list of all params used by the device. | |
Public Member Functions inherited from yarp::dev::IDeviceDriverParams | |
virtual | ~IDeviceDriverParams () |
Additional Inherited Members | |
Public Attributes inherited from JoypadControlServer_ParamsParser | |
const std::string | m_device_classname = {"JoypadControlServer"} |
const std::string | m_device_name = {"JoypadControlServer"} |
bool | m_parser_is_strict = false |
const parser_version_type | m_parser_version = {} |
const std::string | m_period_defaultValue = {"0.01"} |
const std::string | m_name_defaultValue = {"/robotName/joypad"} |
const std::string | m_use_separate_ports_defaultValue = {"true"} |
const std::string | m_profile_defaultValue = {"false"} |
double | m_period = {0.01} |
std::string | m_name = {"/robotName/joypad"} |
bool | m_use_separate_ports = {true} |
bool | m_profile = {false} |
Protected Member Functions inherited from yarp::os::PeriodicThread | |
virtual void | beforeStart () |
Called just before a new thread starts. | |
virtual void | afterStart (bool success) |
Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start(). | |
JoypadControlServer
: joypad input network wrapper on server side
Parameters required by this device are shown in class: JoypadControlServer_ParamsParser
Definition at line 46 of file JoypadControlServer.h.
JoypadControlServer::JoypadControlServer | ( | ) |
Definition at line 224 of file JoypadControlServer.cpp.
|
delete |
|
delete |
|
override |
Definition at line 228 of file JoypadControlServer.cpp.
|
overridevirtual |
Attach to another object.
driver | the polydriver that you want to attach to. |
Implements yarp::dev::IWrapper.
Definition at line 254 of file JoypadControlServer.cpp.
|
overridevirtual |
Close the DeviceDriver.
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 701 of file JoypadControlServer.cpp.
|
overridevirtual |
Detach the object (you must have first called attach).
Implements yarp::dev::IWrapper.
Definition at line 281 of file JoypadControlServer.cpp.
|
overridevirtual |
Open the DeviceDriver.
config | is a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device). |
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 232 of file JoypadControlServer.cpp.
|
delete |
|
delete |
|
overridevirtual |
Loop function.
This is the thread itself. The thread calls the run() function every <period> ms. 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 run() 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.
Implements yarp::os::PeriodicThread.
Definition at line 550 of file JoypadControlServer.cpp.
|
overridevirtual |
Initialization method.
The thread executes this function when it starts and before "run". This is a good place to perform initialization tasks that need to be done by the thread itself (device drivers initialization, memory allocation etc). If the function returns false the thread quits and never calls "run". The return value of threadInit() is notified to the class and passed as a parameter to afterStart(). Note that afterStart() is called by the same thread that is executing the "start" method.
Reimplemented from yarp::os::PeriodicThread.
Definition at line 291 of file JoypadControlServer.cpp.
|
overridevirtual |
Release method.
The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).
Reimplemented from yarp::os::PeriodicThread.
Definition at line 297 of file JoypadControlServer.cpp.