multipleanalogsensorsclient: The client side of a device exposing MultipleAnalogSensors interfaces. More...

#include <networkWrappers/multipleanalogsensorsclient/MultipleAnalogSensorsClient.h>

Inheritance diagram for MultipleAnalogSensorsClient:

Public Member Functions
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

size_t	getNrOfThreeAxisGyroscopes () const override
	Get the number of three axis gyroscopes exposed by this sensor.

yarp::dev::MAS_status	getThreeAxisGyroscopeStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getThreeAxisGyroscopeName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getThreeAxisGyroscopeFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getThreeAxisGyroscopeMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the gyroscope.

size_t	getNrOfThreeAxisLinearAccelerometers () const override
	Get the number of three axis linear accelerometers exposed by this device.

yarp::dev::MAS_status	getThreeAxisLinearAccelerometerStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getThreeAxisLinearAccelerometerName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getThreeAxisLinearAccelerometerFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getThreeAxisLinearAccelerometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getNrOfThreeAxisAngularAccelerometers () const override
	Get the number of three axis angular accelerometers exposed by this device.

yarp::dev::MAS_status	getThreeAxisAngularAccelerometerStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getThreeAxisAngularAccelerometerName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getThreeAxisAngularAccelerometerFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getThreeAxisAngularAccelerometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getNrOfThreeAxisMagnetometers () const override
	Get the number of magnetometers exposed by this device.

yarp::dev::MAS_status	getThreeAxisMagnetometerStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getThreeAxisMagnetometerName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getThreeAxisMagnetometerFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getThreeAxisMagnetometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getNrOfPositionSensors () const override
	Get the number of position sensors exposed by this device.

yarp::dev::MAS_status	getPositionSensorStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getPositionSensorName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getPositionSensorFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getPositionSensorMeasure (size_t sens_index, yarp::sig::Vector &xyz, double &timestamp) const override
	Get the last reading of the position sensor as x y z.

size_t	getNrOfLinearVelocitySensors () const override
	Get the number of linear velocity sensors exposed by this device.

yarp::dev::MAS_status	getLinearVelocitySensorStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getLinearVelocitySensorName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getLinearVelocitySensorFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getLinearVelocitySensorMeasure (size_t sens_index, yarp::sig::Vector &xyz, double &timestamp) const override
	Get the last reading of the linear velocity sensor as x y z.

size_t	getNrOfOrientationSensors () const override
	Get the number of orientation sensors exposed by this device.

yarp::dev::MAS_status	getOrientationSensorStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getOrientationSensorName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getOrientationSensorFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getOrientationSensorMeasureAsRollPitchYaw (size_t sens_index, yarp::sig::Vector &rpy, double &timestamp) const override
	Get the last reading of the orientation sensor as roll pitch yaw.

size_t	getNrOfTemperatureSensors () const override
	Get the number of temperature sensors exposed by this device.

yarp::dev::MAS_status	getTemperatureSensorStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getTemperatureSensorName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getTemperatureSensorFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getTemperatureSensorMeasure (size_t sens_index, double &out, double &timestamp) const override
	Get the last reading of the specified sensor.

bool	getTemperatureSensorMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getNrOfSixAxisForceTorqueSensors () const override
	Get the number of six axis force torque sensors exposed by this device.

yarp::dev::MAS_status	getSixAxisForceTorqueSensorStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getSixAxisForceTorqueSensorName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getSixAxisForceTorqueSensorFrameName (size_t sens_index, std::string &frame) const override
	Get the name of the frame of the specified sensor.

bool	getSixAxisForceTorqueSensorMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getNrOfContactLoadCellArrays () const override
	Get the number of contact load cell array exposed by this device.

yarp::dev::MAS_status	getContactLoadCellArrayStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getContactLoadCellArrayName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getContactLoadCellArrayMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getContactLoadCellArraySize (size_t sens_index) const override
	Get the size of the specified contact load cell array.

size_t	getNrOfEncoderArrays () const override
	Get the number of encoder arrays exposed by this device.

yarp::dev::MAS_status	getEncoderArrayStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getEncoderArrayName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getEncoderArrayMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getEncoderArraySize (size_t sens_index) const override
	Get the size of the specified encoder array.

size_t	getNrOfSkinPatches () const override
	Get the number of skin patches exposed by this device.

yarp::dev::MAS_status	getSkinPatchStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getSkinPatchName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getSkinPatchMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getSkinPatchSize (size_t sens_index) const override
	Get the size of the specified skin patch.

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::IThreeAxisGyroscopes
virtual	~IThreeAxisGyroscopes ()

Public Member Functions inherited from yarp::dev::IThreeAxisLinearAccelerometers
virtual	~IThreeAxisLinearAccelerometers ()

Public Member Functions inherited from yarp::dev::IThreeAxisAngularAccelerometers
virtual	~IThreeAxisAngularAccelerometers ()

Public Member Functions inherited from yarp::dev::IThreeAxisMagnetometers
virtual	~IThreeAxisMagnetometers ()

Public Member Functions inherited from yarp::dev::IPositionSensors
virtual	~IPositionSensors ()

Public Member Functions inherited from yarp::dev::ILinearVelocitySensors
virtual	~ILinearVelocitySensors ()

Public Member Functions inherited from yarp::dev::IOrientationSensors
virtual	~IOrientationSensors ()

Public Member Functions inherited from yarp::dev::ITemperatureSensors
virtual	~ITemperatureSensors ()

Public Member Functions inherited from yarp::dev::ISixAxisForceTorqueSensors
virtual	~ISixAxisForceTorqueSensors ()

Public Member Functions inherited from yarp::dev::IContactLoadCellArrays
virtual	~IContactLoadCellArrays ()

Public Member Functions inherited from yarp::dev::IEncoderArrays
virtual	~IEncoderArrays ()

Public Member Functions inherited from yarp::dev::ISkinPatches
virtual	~ISkinPatches ()

Public Member Functions inherited from MultipleAnalogSensorsClient_ParamsParser
	MultipleAnalogSensorsClient_ParamsParser ()

	~MultipleAnalogSensorsClient_ParamsParser () override=default

bool	parseParams (const yarp::os::Searchable &config) override
	Parse the DeviceDriver parameters.

std::string	getDeviceClassName () const override
	Get the name of the DeviceDriver class.

std::string	getDeviceName () const override
	Get the name of the device (i.e.

std::string	getDocumentationOfDeviceParams () const override
	Get the documentation of the DeviceDriver's parameters.

std::vector< std::string >	getListOfParams () const override
	Return a list of all params used by the device.

Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Additional Inherited Members
Public Attributes inherited from MultipleAnalogSensorsClient_ParamsParser
const std::string	m_device_classname = {"MultipleAnalogSensorsClient"}

const std::string	m_device_name = {"multipleanalogsensorsclient"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_remote_defaultValue = {""}

const std::string	m_local_defaultValue = {""}

const std::string	m_timeout_defaultValue = {"0.02"}

const std::string	m_externalConnection_defaultValue = {"false"}

const std::string	m_carrier_defaultValue = {"tcp"}

std::string	m_remote = {}

std::string	m_local = {}

double	m_timeout = {0.02}

bool	m_externalConnection = {false}

std::string	m_carrier = {"tcp"}

Detailed Description

multipleanalogsensorsclient: The client side of a device exposing MultipleAnalogSensors interfaces.

Parameters required by this device are shown in class: MultipleAnalogSensorsClient_ParamsParser

Definition at line 46 of file MultipleAnalogSensorsClient.h.

Member Function Documentation

◆ close()

bool MultipleAnalogSensorsClient::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 120 of file MultipleAnalogSensorsClient.cpp.

◆ getContactLoadCellArrayMeasure()

bool MultipleAnalogSensorsClient::getContactLoadCellArrayMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getContactLoadCellArrayMeasure()-1).
[out]	out	The requested measure. The vector should be getContactLoadCellArrayMeasure(sens_index)-dimensional. The measure is expressed in Newton.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IContactLoadCellArrays.

Definition at line 559 of file MultipleAnalogSensorsClient.cpp.

◆ getContactLoadCellArrayName()

bool MultipleAnalogSensorsClient::getContactLoadCellArrayName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IContactLoadCellArrays.

Definition at line 554 of file MultipleAnalogSensorsClient.cpp.

◆ getContactLoadCellArraySize()

size_t MultipleAnalogSensorsClient::getContactLoadCellArraySize ( size_t sens_index ) const

overridevirtual

Get the size of the specified contact load cell array.

Implements yarp::dev::IContactLoadCellArrays.

Definition at line 565 of file MultipleAnalogSensorsClient.cpp.

◆ getContactLoadCellArrayStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getContactLoadCellArrayStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IContactLoadCellArrays.

Definition at line 549 of file MultipleAnalogSensorsClient.cpp.

◆ getEncoderArrayMeasure()

bool MultipleAnalogSensorsClient::getEncoderArrayMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfEncoderArrays()-1).
[out]	out	The requested measure. The vector should be getEncoderArraySize(sens_index)-dimensional. The measure is expressed in Newton.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Implements yarp::dev::IEncoderArrays.

Definition at line 587 of file MultipleAnalogSensorsClient.cpp.

◆ getEncoderArrayName()

bool MultipleAnalogSensorsClient::getEncoderArrayName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Implements yarp::dev::IEncoderArrays.

Definition at line 582 of file MultipleAnalogSensorsClient.cpp.

◆ getEncoderArraySize()

size_t MultipleAnalogSensorsClient::getEncoderArraySize ( size_t sens_index ) const

overridevirtual

Get the size of the specified encoder array.

Implements yarp::dev::IEncoderArrays.

Definition at line 593 of file MultipleAnalogSensorsClient.cpp.

◆ getEncoderArrayStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getEncoderArrayStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IEncoderArrays.

Definition at line 577 of file MultipleAnalogSensorsClient.cpp.

◆ getLinearVelocitySensorFrameName()

bool MultipleAnalogSensorsClient::getLinearVelocitySensorFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Note: This is an implementation specific method, that may return the name of the sensor frame in a scenegraph

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::ILinearVelocitySensors.

Definition at line 471 of file MultipleAnalogSensorsClient.cpp.

◆ getLinearVelocitySensorMeasure()

bool MultipleAnalogSensorsClient::getLinearVelocitySensorMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	xyz,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the linear velocity sensor as x y z.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfLinearVelocitySensors()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in meters/second.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::ILinearVelocitySensors.

Definition at line 476 of file MultipleAnalogSensorsClient.cpp.

◆ getLinearVelocitySensorName()

bool MultipleAnalogSensorsClient::getLinearVelocitySensorName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::ILinearVelocitySensors.

Definition at line 466 of file MultipleAnalogSensorsClient.cpp.

◆ getLinearVelocitySensorStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getLinearVelocitySensorStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::ILinearVelocitySensors.

Definition at line 461 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfContactLoadCellArrays()

size_t MultipleAnalogSensorsClient::getNrOfContactLoadCellArrays ( ) const

overridevirtual

Get the number of contact load cell array exposed by this device.

Implements yarp::dev::IContactLoadCellArrays.

Definition at line 543 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfEncoderArrays()

size_t MultipleAnalogSensorsClient::getNrOfEncoderArrays ( ) const

overridevirtual

Get the number of encoder arrays exposed by this device.

Implements yarp::dev::IEncoderArrays.

Definition at line 571 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfLinearVelocitySensors()

size_t MultipleAnalogSensorsClient::getNrOfLinearVelocitySensors ( ) const

overridevirtual

Get the number of linear velocity sensors exposed by this device.

Implements yarp::dev::ILinearVelocitySensors.

Definition at line 455 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfOrientationSensors()

size_t MultipleAnalogSensorsClient::getNrOfOrientationSensors ( ) const

overridevirtual

Get the number of orientation sensors exposed by this device.

Implements yarp::dev::IOrientationSensors.

Definition at line 402 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfPositionSensors()

size_t MultipleAnalogSensorsClient::getNrOfPositionSensors ( ) const

overridevirtual

Get the number of position sensors exposed by this device.

Implements yarp::dev::IPositionSensors.

Definition at line 429 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfSixAxisForceTorqueSensors()

size_t MultipleAnalogSensorsClient::getNrOfSixAxisForceTorqueSensors ( ) const

overridevirtual

Get the number of six axis force torque sensors exposed by this device.

Implements yarp::dev::ISixAxisForceTorqueSensors.

Definition at line 516 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfSkinPatches()

size_t MultipleAnalogSensorsClient::getNrOfSkinPatches ( ) const

overridevirtual

Get the number of skin patches exposed by this device.

Implements yarp::dev::ISkinPatches.

Definition at line 599 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfTemperatureSensors()

size_t MultipleAnalogSensorsClient::getNrOfTemperatureSensors ( ) const

overridevirtual

Get the number of temperature sensors exposed by this device.

Implements yarp::dev::ITemperatureSensors.

Definition at line 481 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfThreeAxisAngularAccelerometers()

size_t MultipleAnalogSensorsClient::getNrOfThreeAxisAngularAccelerometers ( ) const

overridevirtual

Get the number of three axis angular accelerometers exposed by this device.

Implements yarp::dev::IThreeAxisAngularAccelerometers.

Definition at line 348 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfThreeAxisGyroscopes()

size_t MultipleAnalogSensorsClient::getNrOfThreeAxisGyroscopes ( ) const

overridevirtual

Get the number of three axis gyroscopes exposed by this sensor.

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 294 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfThreeAxisLinearAccelerometers()

size_t MultipleAnalogSensorsClient::getNrOfThreeAxisLinearAccelerometers ( ) const

overridevirtual

Get the number of three axis linear accelerometers exposed by this device.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 321 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfThreeAxisMagnetometers()

size_t MultipleAnalogSensorsClient::getNrOfThreeAxisMagnetometers ( ) const

overridevirtual

Get the number of magnetometers exposed by this device.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 375 of file MultipleAnalogSensorsClient.cpp.

◆ getOrientationSensorFrameName()

bool MultipleAnalogSensorsClient::getOrientationSensorFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Note: This is an implementation specific method, that may return the name of the sensor frame in a scenegraph

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IOrientationSensors.

Definition at line 418 of file MultipleAnalogSensorsClient.cpp.

◆ getOrientationSensorMeasureAsRollPitchYaw()

bool MultipleAnalogSensorsClient::getOrientationSensorMeasureAsRollPitchYaw	(	size_t	sens_index,
		yarp::sig::Vector &	rpy,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the orientation sensor as roll pitch yaw.

If $ f $ is the lab or surface fixed frame, and $ s $ is the sensor-fixed frame, this methods returns the angles $r \in [-180, 180] , p \in [-90, 90], y \in [-180, 180]$ such that

${}^f R_s = RotZ\left(\frac{\pi}{180}y\right)*RotY\left(\frac{\pi}{180}p\right)*RotX\left(\frac{\pi}{180}r\right)$

with

$RotZ(\theta) = \begin{bmatrix} \cos(\theta) & -\sin(\theta) & 0 \\ \sin(\theta) & \cos(\theta) & 0 \\ 0 & 0 & 1 \\ \end{bmatrix}$

,

$RotY(\theta) = \begin{bmatrix} \cos(\theta) & 0 & \sin(\theta) \\ 0 & 1 & 0 \\ -\sin(\theta) & 0 & \cos(\theta) \\ \end{bmatrix}$

and

$RotX(\theta) = \begin{bmatrix} 1 & 0 & 0 \\ 0 & \cos(\theta) & - \sin(\theta) \\ 0 & \sin(\theta) & \cos(\theta) \\ \end{bmatrix}$

where ${}^f R_s \in \mathbb{R}^{3 \times 3}$ is the rotation that left-multiplied by a 3d column vector expressed in $ s $ it returns it expressed in $ f $ .

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfOrientationSensors()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in degrees .
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IOrientationSensors.

Definition at line 423 of file MultipleAnalogSensorsClient.cpp.

◆ getOrientationSensorName()

bool MultipleAnalogSensorsClient::getOrientationSensorName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IOrientationSensors.

Definition at line 413 of file MultipleAnalogSensorsClient.cpp.

◆ getOrientationSensorStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getOrientationSensorStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IOrientationSensors.

Definition at line 408 of file MultipleAnalogSensorsClient.cpp.

◆ getPositionSensorFrameName()

bool MultipleAnalogSensorsClient::getPositionSensorFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Note: This is an implementation specific method, that may return the name of the sensor frame in a scenegraph

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IPositionSensors.

Definition at line 445 of file MultipleAnalogSensorsClient.cpp.

◆ getPositionSensorMeasure()

bool MultipleAnalogSensorsClient::getPositionSensorMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	xyz,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the position sensor as x y z.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfPositionSensors()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in meters.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IPositionSensors.

Definition at line 450 of file MultipleAnalogSensorsClient.cpp.

◆ getPositionSensorName()

bool MultipleAnalogSensorsClient::getPositionSensorName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IPositionSensors.

Definition at line 440 of file MultipleAnalogSensorsClient.cpp.

◆ getPositionSensorStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getPositionSensorStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IPositionSensors.

Definition at line 435 of file MultipleAnalogSensorsClient.cpp.

◆ getSixAxisForceTorqueSensorFrameName()

bool MultipleAnalogSensorsClient::getSixAxisForceTorqueSensorFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Implements yarp::dev::ISixAxisForceTorqueSensors.

Definition at line 532 of file MultipleAnalogSensorsClient.cpp.

◆ getSixAxisForceTorqueSensorMeasure()

bool MultipleAnalogSensorsClient::getSixAxisForceTorqueSensorMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfSixAxisForceTorqueSensors()-1).
[out]	out	The requested measure. The vector should be 6-dimensional. The measure is expressed in Newton for the first three elements, Newton Meters for the last three elements.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Implements yarp::dev::ISixAxisForceTorqueSensors.

Definition at line 537 of file MultipleAnalogSensorsClient.cpp.

◆ getSixAxisForceTorqueSensorName()

bool MultipleAnalogSensorsClient::getSixAxisForceTorqueSensorName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Implements yarp::dev::ISixAxisForceTorqueSensors.

Definition at line 527 of file MultipleAnalogSensorsClient.cpp.

◆ getSixAxisForceTorqueSensorStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getSixAxisForceTorqueSensorStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::ISixAxisForceTorqueSensors.

Definition at line 522 of file MultipleAnalogSensorsClient.cpp.

◆ getSkinPatchMeasure()

bool MultipleAnalogSensorsClient::getSkinPatchMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfSkinPatches()-1).
[out]	out	The requested measure. The vector should be getSkinPatchSize(sens_index)-dimensional. The measure is expressed in implementation-specific unit of measure.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Implements yarp::dev::ISkinPatches.

Definition at line 615 of file MultipleAnalogSensorsClient.cpp.

◆ getSkinPatchName()

bool MultipleAnalogSensorsClient::getSkinPatchName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Implements yarp::dev::ISkinPatches.

Definition at line 610 of file MultipleAnalogSensorsClient.cpp.

◆ getSkinPatchSize()

size_t MultipleAnalogSensorsClient::getSkinPatchSize ( size_t sens_index ) const

overridevirtual

Get the size of the specified skin patch.

Implements yarp::dev::ISkinPatches.

Definition at line 621 of file MultipleAnalogSensorsClient.cpp.

◆ getSkinPatchStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getSkinPatchStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::ISkinPatches.

Definition at line 605 of file MultipleAnalogSensorsClient.cpp.

◆ getTemperatureSensorFrameName()

bool MultipleAnalogSensorsClient::getTemperatureSensorFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Implements yarp::dev::ITemperatureSensors.

Definition at line 497 of file MultipleAnalogSensorsClient.cpp.

◆ getTemperatureSensorMeasure() [1/2]

bool MultipleAnalogSensorsClient::getTemperatureSensorMeasure	(	size_t	sens_index,
		double &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

TODO(traversaro) : make the method swig-friendly

Implements yarp::dev::ITemperatureSensors.

Definition at line 508 of file MultipleAnalogSensorsClient.cpp.

◆ getTemperatureSensorMeasure() [2/2]

bool MultipleAnalogSensorsClient::getTemperatureSensorMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfTemperatureSensors()-1).
[out]	out	The requested measure. The vector should be 1-dimensional. The measure is expressed in celsius degrees .
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::ITemperatureSensors.

Definition at line 502 of file MultipleAnalogSensorsClient.cpp.

◆ getTemperatureSensorName()

bool MultipleAnalogSensorsClient::getTemperatureSensorName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Implements yarp::dev::ITemperatureSensors.

Definition at line 492 of file MultipleAnalogSensorsClient.cpp.

◆ getTemperatureSensorStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getTemperatureSensorStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::ITemperatureSensors.

Definition at line 487 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisAngularAccelerometerFrameName()

bool MultipleAnalogSensorsClient::getThreeAxisAngularAccelerometerFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisAngularAccelerometers.

Definition at line 364 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisAngularAccelerometerMeasure()

bool MultipleAnalogSensorsClient::getThreeAxisAngularAccelerometerMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfThreeAxisAngularAccelerometers()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in degrees^2/seconds.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisAngularAccelerometers.

Definition at line 369 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisAngularAccelerometerName()

bool MultipleAnalogSensorsClient::getThreeAxisAngularAccelerometerName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisAngularAccelerometers.

Definition at line 359 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisAngularAccelerometerStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getThreeAxisAngularAccelerometerStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IThreeAxisAngularAccelerometers.

Definition at line 354 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisGyroscopeFrameName()

bool MultipleAnalogSensorsClient::getThreeAxisGyroscopeFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Parameters

[in] sens_index The index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 310 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisGyroscopeMeasure()

bool MultipleAnalogSensorsClient::getThreeAxisGyroscopeMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the gyroscope.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in degrees/seconds.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 315 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisGyroscopeName()

bool MultipleAnalogSensorsClient::getThreeAxisGyroscopeName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Parameters

[in] sens_index The index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 305 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisGyroscopeStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getThreeAxisGyroscopeStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Parameters

[in] sens_index The index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 300 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisLinearAccelerometerFrameName()

bool MultipleAnalogSensorsClient::getThreeAxisLinearAccelerometerFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 337 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisLinearAccelerometerMeasure()

bool MultipleAnalogSensorsClient::getThreeAxisLinearAccelerometerMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfThreeAxisLinearAccelerometers()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in meters^2/seconds.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 342 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisLinearAccelerometerName()

bool MultipleAnalogSensorsClient::getThreeAxisLinearAccelerometerName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 332 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisLinearAccelerometerStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getThreeAxisLinearAccelerometerStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 327 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisMagnetometerFrameName()

bool MultipleAnalogSensorsClient::getThreeAxisMagnetometerFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 391 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisMagnetometerMeasure()

bool MultipleAnalogSensorsClient::getThreeAxisMagnetometerMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfThreeAxisMagnetometers()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in tesla .
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 396 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisMagnetometerName()

bool MultipleAnalogSensorsClient::getThreeAxisMagnetometerName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 386 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisMagnetometerStatus()

yarp::dev::MAS_status MultipleAnalogSensorsClient::getThreeAxisMagnetometerStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 381 of file MultipleAnalogSensorsClient.cpp.

◆ open()

bool MultipleAnalogSensorsClient::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 40 of file MultipleAnalogSensorsClient.cpp.

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

src/devices/networkWrappers/multipleanalogsensorsclient/MultipleAnalogSensorsClient.h
src/devices/networkWrappers/multipleanalogsensorsclient/MultipleAnalogSensorsClient.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ close()

◆ getContactLoadCellArrayMeasure()

◆ getContactLoadCellArrayName()

◆ getContactLoadCellArraySize()

◆ getContactLoadCellArrayStatus()

◆ getEncoderArrayMeasure()

◆ getEncoderArrayName()

◆ getEncoderArraySize()

◆ getEncoderArrayStatus()

◆ getLinearVelocitySensorFrameName()

◆ getLinearVelocitySensorMeasure()

◆ getLinearVelocitySensorName()

◆ getLinearVelocitySensorStatus()

◆ getNrOfContactLoadCellArrays()

◆ getNrOfEncoderArrays()

◆ getNrOfLinearVelocitySensors()

◆ getNrOfOrientationSensors()

◆ getNrOfPositionSensors()

◆ getNrOfSixAxisForceTorqueSensors()

◆ getNrOfSkinPatches()

◆ getNrOfTemperatureSensors()

◆ getNrOfThreeAxisAngularAccelerometers()

◆ getNrOfThreeAxisGyroscopes()

◆ getNrOfThreeAxisLinearAccelerometers()

◆ getNrOfThreeAxisMagnetometers()

◆ getOrientationSensorFrameName()

◆ getOrientationSensorMeasureAsRollPitchYaw()

◆ getOrientationSensorName()

◆ getOrientationSensorStatus()

◆ getPositionSensorFrameName()

◆ getPositionSensorMeasure()

◆ getPositionSensorName()

◆ getPositionSensorStatus()

◆ getSixAxisForceTorqueSensorFrameName()

◆ getSixAxisForceTorqueSensorMeasure()

◆ getSixAxisForceTorqueSensorName()

◆ getSixAxisForceTorqueSensorStatus()

◆ getSkinPatchMeasure()

◆ getSkinPatchName()

◆ getSkinPatchSize()

◆ getSkinPatchStatus()

◆ getTemperatureSensorFrameName()

◆ getTemperatureSensorMeasure() [1/2]

◆ getTemperatureSensorMeasure() [2/2]

◆ getTemperatureSensorName()

◆ getTemperatureSensorStatus()

◆ getThreeAxisAngularAccelerometerFrameName()

◆ getThreeAxisAngularAccelerometerMeasure()

◆ getThreeAxisAngularAccelerometerName()

◆ getThreeAxisAngularAccelerometerStatus()

◆ getThreeAxisGyroscopeFrameName()

◆ getThreeAxisGyroscopeMeasure()

◆ getThreeAxisGyroscopeName()

◆ getThreeAxisGyroscopeStatus()

◆ getThreeAxisLinearAccelerometerFrameName()

◆ getThreeAxisLinearAccelerometerMeasure()

◆ getThreeAxisLinearAccelerometerName()

◆ getThreeAxisLinearAccelerometerStatus()

◆ getThreeAxisMagnetometerFrameName()

◆ getThreeAxisMagnetometerMeasure()

◆ getThreeAxisMagnetometerName()

◆ getThreeAxisMagnetometerStatus()

◆ open()