yarp::dev::WrapperSingle Class Reference

Helper interface for an object that can wrap/or "attach" to a single other device. More...

#include <yarp/dev/WrapperSingle.h>

Inherits yarp::dev::IWrapper, and yarp::dev::IMultipleWrapper.

Inherited by AudioPlayerWrapper, AudioRecorder_nws_yarp, Battery_nws_ros2, Battery_nws_yarp, ChatBot_nws_yarp, ControlBoardCouplingHandler, ControlBoard_nws_ros, ControlBoard_nws_ros2, ControlBoard_nws_yarp, FakeDeviceWrapper, FakeDevice_nws_yarp, FrameGrabber_nws_ros, FrameGrabber_nws_ros2, FrameGrabber_nws_yarp, FrameTransformGet_nws_yarp, FrameTransformSet_nws_yarp, FrameTransformStorage, FrameWriter_nws_yarp, JoypadControlServer, LLM_nws_yarp, Localization2D_nws_ros, Localization2D_nws_ros2, Localization2D_nws_yarp, Map2D_nws_ros, Map2D_nws_ros2, Map2D_nws_yarp, MobileBaseVelocityControl_nws_ros, MobileBaseVelocityControl_nws_ros2, MobileBaseVelocityControl_nws_yarp, MultipleAnalogSensorsServer, Navigation2D_nws_yarp, Odometry2D_nws_ros, Odometry2D_nws_ros2, Odometry2D_nws_yarp, RGBDToPointCloudSensor_nws_ros, Rangefinder2DTransformer, Rangefinder2D_controlBoard_nws_ros2, Rangefinder2D_nws_ros, Rangefinder2D_nws_ros2, Rangefinder2D_nws_yarp, RgbdSensor_nws_ros, RgbdSensor_nws_ros2, RgbdSensor_nws_yarp, RgbdToPointCloudSensor_nws_ros2, RobotDescription_nws_yarp, SerialPort_nws_yarp, SpeechSynthesizer_nws_yarp, and SpeechTranscription_nws_yarp.

Public Member Functions
	~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.
virtual bool	attach (PolyDriver *driver)=0
	Attach to another object.
virtual bool	detach ()=0
	Detach the object (you must have first called attach).
Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual	~IMultipleWrapper ()
	Destructor.

Detailed Description

Helper interface for an object that can wrap/or "attach" to a single other device.

The IWrapper methods should be implemented by the user, but the device can be used also through the IMultipleWrapper interface.

Definition at line 28 of file WrapperSingle.h.

Constructor & Destructor Documentation

~WrapperSingle()

yarp::dev::WrapperSingle::~WrapperSingle ( )

overridedefault

Destructor.

Member Function Documentation

attachAll()

bool yarp::dev::WrapperSingle::attachAll ( const yarp::dev::PolyDriverList &  drivers )

finalvirtual

Attach to a list of objects.

Parameters

drivers

the polydriver list that you want to attach to.

Returns

true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 18 of file WrapperSingle.cpp.

detachAll()

bool yarp::dev::WrapperSingle::detachAll ( )

finalvirtual

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

Returns

true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 34 of file WrapperSingle.cpp.

---

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

• src/libYARP_dev/src/yarp/dev/WrapperSingle.h
• src/libYARP_dev/src/yarp/dev/WrapperSingle.cpp