SimulatedWorld_nws_yarp: Device that expose a simulator engine (using the ISimulatedWorld interface) on the YARP network.
More...
#include <networkWrappers/simulatedWorld_nws_yarp/SimulatedWorld_nws_yarp.h>
Inheritance diagram for SimulatedWorld_nws_yarp:Public Member Functions | |
| SimulatedWorld_nws_yarp () | |
| ~SimulatedWorld_nws_yarp () | |
| bool | open (yarp::os::Searchable ¶ms) override |
| Open the DeviceDriver. | |
| bool | close () override |
| Close the DeviceDriver. | |
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::PortReader | |
| virtual | ~PortReader () |
| Destructor. | |
| virtual Type | getReadType () const |
Public Member Functions inherited from SimulatedWorld_nws_yarp_ParamsParser | |
| SimulatedWorld_nws_yarp_ParamsParser () | |
| ~SimulatedWorld_nws_yarp_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. | |
| bool | getParamValue (const std::string ¶mName, std::string ¶mValue) const override |
| Return the value (represented as a string) of the requested parameter. | |
| std::string | getConfiguration () const override |
| Return the configuration of the device. | |
Public Member Functions inherited from yarp::dev::IDeviceDriverParams | |
| virtual | ~IDeviceDriverParams () |
Additional Inherited Members | |
Public Attributes inherited from SimulatedWorld_nws_yarp_ParamsParser | |
| const std::string | m_device_classname = {"SimulatedWorld_nws_yarp"} |
| const std::string | m_device_name = {"simulatedWorld_nws_yarp"} |
| bool | m_parser_is_strict = false |
| const parser_version_type | m_parser_version = {} |
| std::string | m_provided_configuration |
| const std::string | m_name_defaultValue = {"/robotName/battery1"} |
| std::string | m_name = {"/robotName/battery1"} |
SimulatedWorld_nws_yarp: Device that expose a simulator engine (using the ISimulatedWorld interface) on the YARP network.
Parameters required by this device are shown in class: SimulatedWorld_nws_yarp_ParamsParser
Definition at line 73 of file SimulatedWorld_nws_yarp.h.
| SimulatedWorld_nws_yarp::SimulatedWorld_nws_yarp | ( | ) |
Definition at line 22 of file SimulatedWorld_nws_yarp.cpp.
| SimulatedWorld_nws_yarp::~SimulatedWorld_nws_yarp | ( | ) |
Definition at line 26 of file SimulatedWorld_nws_yarp.cpp.
|
overridevirtual |
Close the DeviceDriver.
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 89 of file SimulatedWorld_nws_yarp.cpp.
|
overridevirtual |
Open the DeviceDriver.
| config | is a list of parameters for the device. Which parameters are effective for your device can vary. 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 73 of file SimulatedWorld_nws_yarp.cpp.