StubDriver Class Reference

Inheritance diagram for StubDriver:

Public Member Functions
	StubDriver (const char *dll_name, const char *fn_name)
	StubDriver (const char *name)
virtual	~StubDriver ()=default
void	init ()
bool	isValid () const
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.
bool	close () override
	Close the DeviceDriver.
void	setId (const std::string &id) override
	Set the id for this device.
std::string	id () const override
	Return the id assigned to the PolyDriver.
DeviceDriver *	getImplementation () override
	Some drivers are bureaucrats, pointing at others.
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
DeviceDriver &	operator= (const DeviceDriver &other)=delete
DeviceDriver &	operator= (DeviceDriver &&other) noexcept=delete
virtual	~DeviceDriver ()
template<class T >
bool	view (T *&x)
	Get an interface to the device driver.

Detailed Description

Definition at line 172 of file Drivers.cpp.

Constructor & Destructor Documentation

StubDriver() [1/2]

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

inline

Definition at line 178 of file Drivers.cpp.

StubDriver() [2/2]

StubDriver::StubDriver ( const char *  name )

inline

Definition at line 183 of file Drivers.cpp.

~StubDriver()

virtual StubDriver::~StubDriver ( )

virtualdefault

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

getBaseClassName()

std::string StubDriver::getBaseClassName ( ) const

inline

Definition at line 263 of file Drivers.cpp.

getClassName()

std::string StubDriver::getClassName ( ) const

inline

Definition at line 259 of file Drivers.cpp.

getDllName()

std::string StubDriver::getDllName ( ) const

inline

Definition at line 243 of file Drivers.cpp.

getFnName()

std::string StubDriver::getFnName ( ) const

inline

Definition at line 247 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 239 of file Drivers.cpp.

getPluginName()

std::string StubDriver::getPluginName ( ) const

inline

Definition at line 255 of file Drivers.cpp.

getwrapName()

std::string StubDriver::getwrapName ( ) const

inline

Definition at line 251 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 231 of file Drivers.cpp.

init()

void StubDriver::init ( )

inline

Definition at line 195 of file Drivers.cpp.

isValid()

bool StubDriver::isValid ( ) const

inline

Definition at line 205 of file Drivers.cpp.

open()

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

inlineoverridevirtual

Open the DeviceDriver.

Parameters

config

is 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 209 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 223 of file Drivers.cpp.

---

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

• src/libYARP_dev/src/yarp/dev/Drivers.cpp