YARP
Yet Another Robot Platform
yarp::dev::IWrapper Class Referenceabstract

Interface for an object that can wrap/or "attach" to another. More...

#include <yarp/dev/Wrapper.h>

+ Inheritance diagram for yarp::dev::IWrapper:

Detailed Description

Interface for an object that can wrap/or "attach" to another.

This is useful for example when an object refers internally to another device, but you want to decouple the creation of the two objects. In this case you first creates the two objects separately then you can attach one to the other.

Definition at line 35 of file Wrapper.h.

Public Member Functions

virtual ~IWrapper ()
 Destructor. More...
 
virtual bool attach (PolyDriver *poly)=0
 Attach to another object. More...
 
virtual bool detach ()=0
 Detach the object (you must have first called attach). More...
 

Constructor & Destructor Documentation

◆ ~IWrapper()

virtual yarp::dev::IWrapper::~IWrapper ( )
inlinevirtual

Destructor.

Definition at line 41 of file Wrapper.h.

Member Function Documentation

◆ attach()

virtual bool yarp::dev::IWrapper::attach ( PolyDriver poly)
pure virtual

Attach to another object.

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

Implemented in yarp::dev::ServerGrabber, yarp::dev::RGBDSensorWrapper, yarp::dev::ServerInertial, and yarp::dev::JoypadControlServer.

◆ detach()

virtual bool yarp::dev::IWrapper::detach ( )
pure virtual

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

Returns
true/false on success failure.

Implemented in yarp::dev::ServerGrabber, yarp::dev::RGBDSensorWrapper, yarp::dev::ServerInertial, and yarp::dev::JoypadControlServer.


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