YARP
Yet Another Robot Platform
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>

+ Inheritance diagram for yarp::dev::WrapperSingle:

Public Member Functions

 ~WrapperSingle () override
 Destructor. More...
 
bool attachAll (const yarp::dev::PolyDriverList &drivers) final
 Attach to a list of objects. More...
 
bool detachAll () final
 Detach the object (you must have first called attach). More...
 
- Public Member Functions inherited from yarp::dev::IWrapper
virtual ~IWrapper ()
 Destructor. More...
 
virtual bool attach (PolyDriver *driver)=0
 Attach to another object. More...
 
virtual bool detach ()=0
 Detach the object (you must have first called attach). More...
 
- Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual ~IMultipleWrapper ()
 Destructor. More...
 

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
driversthe 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: