roboticslab::StreamingDevice Class Reference

Abstract class for a YARP streaming device.

#include <StreamingDevice.hpp>

Inheritance diagram for roboticslab::StreamingDevice:

Public Member Functions
	StreamingDevice (yarp::os::Searchable &config)
	Constructor.
virtual	~StreamingDevice ()
	Destructor.
virtual bool	acquireInterfaces ()=0
	Acquires plugin interfaces.
virtual bool	initialize (bool usingStreamingPreset)
	Perform any custom initialization needed. This method is called after the successful creation of the device and once all interface handles are acquired.
virtual bool	acquireData ()=0
	Acquires data from remote device.
virtual bool	transformData (double scaling)
	Performs required operations on stored data.
virtual int	getActuatorState ()
	If actuator command data is available, return its current state.
virtual bool	hasValidMovementData () const
	Checks whether the device may forward acquired and processed data to the controller.
virtual void	sendMovementCommand (double timestamp)=0
	Sends movement command to the cartesian controller.
virtual void	stopMotion ()=0
	Sends a movement command that would stop motion.
void	setCartesianControllerHandle (ICartesianControl *iCartesianControl)
	Stores handle to an ICartesianControl instance.

Protected Attributes
ICartesianControl *	iCartesianControl
std::vector< double >	data
std::vector< bool >	fixedAxes
int	actuatorState

Private Member Functions
void	configureFixedAxes (const yarp::os::Value &v)
	Stores vector of values representing axes that are always fixed.

Private Attributes
friend	CentroidTransform

Constructor & Destructor Documentation

StreamingDevice()

StreamingDevice::StreamingDevice

(

yarp::os::Searchable &

config

)

Parameters

config

List of options the YARP device should be opened with.

Member Function Documentation

acquireData()

virtual bool roboticslab::StreamingDevice::acquireData ( )

pure virtual

Returns

true on success, false otherwise

Implemented in roboticslab::LeapMotionSensorDevice, roboticslab::SpnavSensorDevice, roboticslab::InvalidDevice, and roboticslab::WiimoteSensorDevice.

acquireInterfaces()

virtual bool roboticslab::StreamingDevice::acquireInterfaces ( )

pure virtual

Returns

true on success, false otherwise

Implemented in roboticslab::LeapMotionSensorDevice, roboticslab::SpnavSensorDevice, roboticslab::InvalidDevice, and roboticslab::WiimoteSensorDevice.

getActuatorState()

virtual int roboticslab::StreamingDevice::getActuatorState ( )

inlinevirtual

Returns

integer value describing current actuator state

Reimplemented in roboticslab::LeapMotionSensorDevice, and roboticslab::SpnavSensorDevice.

hasValidMovementData()

bool StreamingDevice::hasValidMovementData ( ) const

virtual

Returns

true if valid, false otherwise

Reimplemented in roboticslab::SpnavSensorDevice, and roboticslab::WiimoteSensorDevice.

initialize()

virtual bool roboticslab::StreamingDevice::initialize ( bool  usingStreamingPreset )

inlinevirtual

Parameters

usingStreamingPreset

Whether the cartesian controller supports streaming command presets or not.

Returns

true on success, false otherwise

Reimplemented in roboticslab::LeapMotionSensorDevice, roboticslab::SpnavSensorDevice, and roboticslab::WiimoteSensorDevice.

sendMovementCommand()

virtual void roboticslab::StreamingDevice::sendMovementCommand ( double  timestamp )

pure virtual

Parameters

timestamp

Current timestamp.

Implemented in roboticslab::LeapMotionSensorDevice, roboticslab::SpnavSensorDevice, roboticslab::InvalidDevice, and roboticslab::WiimoteSensorDevice.

setCartesianControllerHandle()

void roboticslab::StreamingDevice::setCartesianControllerHandle ( ICartesianControl *  iCartesianControl )

inline

Parameters

iCartesianControl

Handle to an ICartesianControl instance.

stopMotion()

virtual void roboticslab::StreamingDevice::stopMotion ( )

pure virtual

Implemented in roboticslab::LeapMotionSensorDevice, roboticslab::SpnavSensorDevice, roboticslab::InvalidDevice, and roboticslab::WiimoteSensorDevice.

transformData()

bool StreamingDevice::transformData ( double  scaling )

virtual

Parameters

scaling

Scaling factor applied to each data value.

Returns

true on success, false otherwise

Reimplemented in roboticslab::LeapMotionSensorDevice, roboticslab::SpnavSensorDevice, and roboticslab::WiimoteSensorDevice.

---

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

• programs/streamingDeviceController/StreamingDevice.hpp
• programs/streamingDeviceController/StreamingDevice.cpp