YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches

MobileBaseVelocityControl_nws_ros2: A device which allows a client application to control the velocity of a mobile base from ros2. The device opens a topic of type ::geometry_msgs::msg::Twist to receive user commands More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-ros2/src/devices/mobileBaseVelocityControl_nws_ros2/MobileBaseVelocityControl_nws_ros2.h>

+ Inheritance diagram for MobileBaseVelocityControl_nws_ros2:

Public Member Functions

 MobileBaseVelocityControl_nws_ros2 ()=default
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
bool detach () override
 Detach the object (you must have first called attach).
 
bool attach (yarp::dev::PolyDriver *driver) override
 Attach to another object.
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriveroperator= (const DeviceDriver &other)=delete
 
DeviceDriveroperator= (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 DeviceDrivergetImplementation ()
 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.
 

Detailed Description

MobileBaseVelocityControl_nws_ros2: A device which allows a client application to control the velocity of a mobile base from ros2. The device opens a topic of type ::geometry_msgs::msg::Twist to receive user commands

MobileBaseVelocityControl_nws_ros2

Parameters required by this device are:

Parameter name SubParameter Type Units Default Value Required Description Notes
node_name - string - - Yes Full name of the opened ros2 node
topic_name - string - - Yes Full name of the opened ros2 topic

Definition at line 49 of file MobileBaseVelocityControl_nws_ros2.h.

Constructor & Destructor Documentation

◆ MobileBaseVelocityControl_nws_ros2()

MobileBaseVelocityControl_nws_ros2::MobileBaseVelocityControl_nws_ros2 ( )
default

Member Function Documentation

◆ attach()

bool MobileBaseVelocityControl_nws_ros2::attach ( yarp::dev::PolyDriver driver)
overridevirtual

Attach to another object.

Parameters
driverthe polydriver that you want to attach to.
Returns
true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 79 of file MobileBaseVelocityControl_nws_ros2.cpp.

◆ close()

bool MobileBaseVelocityControl_nws_ros2::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 98 of file MobileBaseVelocityControl_nws_ros2.cpp.

◆ detach()

bool MobileBaseVelocityControl_nws_ros2::detach ( )
overridevirtual

Detach the object (you must have first called attach).

Returns
true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 73 of file MobileBaseVelocityControl_nws_ros2.cpp.

◆ open()

bool MobileBaseVelocityControl_nws_ros2::open ( yarp::os::Searchable config)
overridevirtual

Open the DeviceDriver.

Parameters
configis 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).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 30 of file MobileBaseVelocityControl_nws_ros2.cpp.


The documentation for this class was generated from the following files: