FakeDeviceUnwrapped Class Reference

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

#include <fake/fakeDeviceUnwrapped/FakeDeviceUnwrapped.h>

Inheritance diagram for FakeDeviceUnwrapped:

Public Member Functions
	FakeDeviceUnwrapped ()=default
	FakeDeviceUnwrapped (const FakeDeviceUnwrapped &)=delete
	FakeDeviceUnwrapped (FakeDeviceUnwrapped &&)=delete
FakeDeviceUnwrapped &	operator= (const FakeDeviceUnwrapped &)=delete
FakeDeviceUnwrapped &	operator= (FakeDeviceUnwrapped &&)=delete
	~FakeDeviceUnwrapped () override=default
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.
bool	close () override
	Close the DeviceDriver.
yarp::dev::ReturnValue	doSomething () override
	A method for testing purposes.
yarp::dev::ReturnValue	testSetValue (int value) override
	This method is used to set a single value inside the test device.
yarp::dev::ReturnValue	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::test::IFakeDeviceInterfaceTest1
virtual	~IFakeDeviceInterfaceTest1 ()
	Destructor.
Public Member Functions inherited from yarp::dev::test::IFakeDeviceInterfaceTest2
virtual	~IFakeDeviceInterfaceTest2 ()

Protected Attributes
int	m_value = {0}

Detailed Description

FakeDeviceUnwrapper: A simple device for testing purposes.

It is can be wrapped on request by FakeDeviceWrapper via DeviceBundler device.

Definition at line 19 of file FakeDeviceUnwrapped.h.

Constructor & Destructor Documentation

FakeDeviceUnwrapped() [1/3]

FakeDeviceUnwrapped::FakeDeviceUnwrapped ( )

default

FakeDeviceUnwrapped() [2/3]

FakeDeviceUnwrapped::FakeDeviceUnwrapped ( const FakeDeviceUnwrapped &  )

delete

FakeDeviceUnwrapped() [3/3]

FakeDeviceUnwrapped::FakeDeviceUnwrapped ( FakeDeviceUnwrapped &&  )

delete

~FakeDeviceUnwrapped()

FakeDeviceUnwrapped::~FakeDeviceUnwrapped ( )

overridedefault

Member Function Documentation

close()

bool FakeDeviceUnwrapped::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 45 of file FakeDeviceUnwrapped.cpp.

doSomething()

yarp::dev::ReturnValue FakeDeviceUnwrapped::doSomething ( )

overridevirtual

A method for testing purposes.

Implements yarp::dev::test::IFakeDeviceInterfaceTest1.

Definition at line 19 of file FakeDeviceUnwrapped.cpp.

open()

bool FakeDeviceUnwrapped::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 39 of file FakeDeviceUnwrapped.cpp.

operator=() [1/2]

FakeDeviceUnwrapped & FakeDeviceUnwrapped::operator= ( const FakeDeviceUnwrapped &  )

delete

operator=() [2/2]

FakeDeviceUnwrapped & FakeDeviceUnwrapped::operator= ( FakeDeviceUnwrapped &&  )

delete

testGetValue()

yarp::dev::ReturnValue FakeDeviceUnwrapped::testGetValue ( int &  value )

overridevirtual

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

Implements yarp::dev::test::IFakeDeviceInterfaceTest2.

Definition at line 32 of file FakeDeviceUnwrapped.cpp.

testSetValue()

yarp::dev::ReturnValue FakeDeviceUnwrapped::testSetValue ( int  value )

overridevirtual

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

Implements yarp::dev::test::IFakeDeviceInterfaceTest2.

Definition at line 25 of file FakeDeviceUnwrapped.cpp.

Member Data Documentation

m_value

int FakeDeviceUnwrapped::m_value = {0}

protected

Definition at line 25 of file FakeDeviceUnwrapped.h.

---

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

• src/devices/fake/fakeDeviceUnwrapped/FakeDeviceUnwrapped.h
• src/devices/fake/fakeDeviceUnwrapped/FakeDeviceUnwrapped.cpp