YARP
Yet Another Robot Platform
StubDriver Class Reference
+ Inheritance diagram for StubDriver:

Public Member Functions

 StubDriver (const char *dll_name, const char *fn_name)
 
 StubDriver (const char *name)
 
 ~StubDriver () override=default
 
void init ()
 
bool isValid () const
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
void setId (const std::string &id) override
 Set the id for this device. More...
 
std::string id () const override
 Return the id assigned to the PolyDriver. More...
 
DeviceDrivergetImplementation () override
 Some drivers are bureaucrats, pointing at others. More...
 
std::string getDllName () const
 
std::string getFnName () const
 
std::string getwrapName () const
 
std::string getPluginName () const
 
std::string getClassName () const
 
std::string getBaseClassName () const
 
- 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
 
 ~DeviceDriver () override
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
virtual std::string id () const
 Return the id assigned to the PolyDriver. More...
 
virtual void setId (const std::string &id)
 Set the id for this device. More...
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver. More...
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others. More...
 
- Public Member Functions inherited from yarp::os::IConfig
virtual ~IConfig ()
 Destructor. More...
 
virtual bool open (Searchable &config)
 Initialize the object. More...
 
virtual bool close ()
 Shut the object down. More...
 
virtual bool configure (Searchable &config)
 Change online parameters. More...
 

Detailed Description

Definition at line 171 of file Drivers.cpp.

Constructor & Destructor Documentation

◆ StubDriver() [1/2]

StubDriver::StubDriver ( const char *  dll_name,
const char *  fn_name 
)
inline

Definition at line 177 of file Drivers.cpp.

◆ StubDriver() [2/2]

StubDriver::StubDriver ( const char *  name)
inline

Definition at line 182 of file Drivers.cpp.

◆ ~StubDriver()

StubDriver::~StubDriver ( )
overridedefault

Member Function Documentation

◆ close()

bool StubDriver::close ( )
inlineoverridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 215 of file Drivers.cpp.

◆ getBaseClassName()

std::string StubDriver::getBaseClassName ( ) const
inline

Definition at line 262 of file Drivers.cpp.

◆ getClassName()

std::string StubDriver::getClassName ( ) const
inline

Definition at line 258 of file Drivers.cpp.

◆ getDllName()

std::string StubDriver::getDllName ( ) const
inline

Definition at line 242 of file Drivers.cpp.

◆ getFnName()

std::string StubDriver::getFnName ( ) const
inline

Definition at line 246 of file Drivers.cpp.

◆ getImplementation()

DeviceDriver * StubDriver::getImplementation ( )
inlineoverridevirtual

Some drivers are bureaucrats, pointing at others.

Such drivers override this method.

Returns
"real" device driver

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 238 of file Drivers.cpp.

◆ getPluginName()

std::string StubDriver::getPluginName ( ) const
inline

Definition at line 254 of file Drivers.cpp.

◆ getwrapName()

std::string StubDriver::getwrapName ( ) const
inline

Definition at line 250 of file Drivers.cpp.

◆ id()

std::string StubDriver::id ( ) const
inlineoverridevirtual

Return the id assigned to the PolyDriver.

If no name was assigned, returns the name of the device (if set) or an empty string. The value can be set by passing the id option when opening the device or with the setId() method.

Returns
the id for this device.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 230 of file Drivers.cpp.

◆ init()

void StubDriver::init ( )
inline

Definition at line 194 of file Drivers.cpp.

◆ isValid()

bool StubDriver::isValid ( ) const
inline

Definition at line 204 of file Drivers.cpp.

◆ open()

bool StubDriver::open ( yarp::os::Searchable config)
inlineoverridevirtual

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 208 of file Drivers.cpp.

◆ setId()

void StubDriver::setId ( const std::string &  id)
inlineoverridevirtual

Set the id for this device.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 222 of file Drivers.cpp.


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