FakeDeviceWrapper Class Reference

FakeDeviceWrapper: A simple device for testing purposes. More...

#include <fake/fakeDeviceWrapper/FakeDeviceWrapper.h>

Inheritance diagram for FakeDeviceWrapper:

Public Member Functions
	FakeDeviceWrapper ()=default
	FakeDeviceWrapper (const FakeDeviceWrapper &)=delete
	FakeDeviceWrapper (FakeDeviceWrapper &&)=delete
FakeDeviceWrapper &	operator= (const FakeDeviceWrapper &)=delete
FakeDeviceWrapper &	operator= (FakeDeviceWrapper &&)=delete
	~FakeDeviceWrapper () override=default
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.
bool	close () override
	Close the DeviceDriver.
bool	detach () override
	Detach the object (you must have first called attach).
bool	attach (yarp::dev::PolyDriver *drv) override
	Attach to another object.
void	testSetValue (int value) override
	This method is used to set a single value inside the test device.
void	testGetValue (int &value) override
	This method is used to get a single value from a test device.
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 ()
virtual std::string	id () const
	Return the id assigned to the PolyDriver.
virtual void	setId (const std::string &id)
	Set the id for this device.
template<class T >
bool	view (T *&x)
	Get an interface to the device driver.
virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.
Public Member Functions inherited from yarp::dev::WrapperSingle
	~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.
Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual	~IMultipleWrapper ()
	Destructor.
Public Member Functions inherited from yarp::dev::test::IFakeDeviceInterfaceTest
virtual	~IFakeDeviceInterfaceTest ()

Detailed Description

FakeDeviceWrapper: A simple device for testing purposes.

It is can wrap both FakeDeviceUnwrapped and FakeDeviceWrapped devices.

Definition at line 19 of file FakeDeviceWrapper.h.

Constructor & Destructor Documentation

FakeDeviceWrapper() [1/3]

FakeDeviceWrapper::FakeDeviceWrapper ( )

default

FakeDeviceWrapper() [2/3]

FakeDeviceWrapper::FakeDeviceWrapper ( const FakeDeviceWrapper &  )

delete

FakeDeviceWrapper() [3/3]

FakeDeviceWrapper::FakeDeviceWrapper ( FakeDeviceWrapper &&  )

delete

~FakeDeviceWrapper()

FakeDeviceWrapper::~FakeDeviceWrapper ( )

overridedefault

Member Function Documentation

attach()

bool FakeDeviceWrapper::attach ( yarp::dev::PolyDriver *  driver )

overridevirtual

Attach to another object.

Parameters

driver

the polydriver that you want to attach to.

Returns

true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 53 of file FakeDeviceWrapper.cpp.

close()

bool FakeDeviceWrapper::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 41 of file FakeDeviceWrapper.cpp.

detach()

bool FakeDeviceWrapper::detach ( )

overridevirtual

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

Returns

true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 47 of file FakeDeviceWrapper.cpp.

open()

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

overridevirtual

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 35 of file FakeDeviceWrapper.cpp.

operator=() [1/2]

FakeDeviceWrapper & FakeDeviceWrapper::operator= ( const FakeDeviceWrapper &  )

delete

operator=() [2/2]

FakeDeviceWrapper & FakeDeviceWrapper::operator= ( FakeDeviceWrapper &&  )

delete

testGetValue()

void FakeDeviceWrapper::testGetValue ( int &  value )

overridevirtual

This method is used to get a single value from a test device.

Implements yarp::dev::test::IFakeDeviceInterfaceTest.

Definition at line 27 of file FakeDeviceWrapper.cpp.

testSetValue()

void FakeDeviceWrapper::testSetValue ( int  value )

overridevirtual

This method is used to set a single value inside the test device.

Implements yarp::dev::test::IFakeDeviceInterfaceTest.

Definition at line 19 of file FakeDeviceWrapper.cpp.

---

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

• src/devices/fake/fakeDeviceWrapper/FakeDeviceWrapper.h
• src/devices/fake/fakeDeviceWrapper/FakeDeviceWrapper.cpp