YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches

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.
 
yarp::dev::ReturnValue getNrOfThreeAxisGyroscopes (size_t &num) 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.
 
yarp::dev::ReturnValue getThreeAxisGyroscopeName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue getThreeAxisGyroscopeFrameName (size_t sens_index, std::string &frameName) const override
 Get the name of the frame of the specified sensor.
 
yarp::dev::ReturnValue getThreeAxisGyroscopeMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
 Get the last reading of the gyroscope.
 
yarp::dev::ReturnValue getNrOfThreeAxisLinearAccelerometers (size_t &num) 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.
 
yarp::dev::ReturnValue getThreeAxisLinearAccelerometerName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue getThreeAxisLinearAccelerometerFrameName (size_t sens_index, std::string &frameName) const override
 Get the name of the frame of the specified sensor.
 
yarp::dev::ReturnValue getThreeAxisLinearAccelerometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
 Get the last reading of the specified sensor.
 
yarp::dev::ReturnValue getNrOfThreeAxisAngularAccelerometers (size_t &num) 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.
 
yarp::dev::ReturnValue getThreeAxisAngularAccelerometerName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue getThreeAxisAngularAccelerometerFrameName (size_t sens_index, std::string &frameName) const override
 Get the name of the frame of the specified sensor.
 
yarp::dev::ReturnValue getThreeAxisAngularAccelerometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
 Get the last reading of the specified sensor.
 
yarp::dev::ReturnValue getNrOfThreeAxisMagnetometers (size_t &num) 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.
 
yarp::dev::ReturnValue getThreeAxisMagnetometerName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue getThreeAxisMagnetometerFrameName (size_t sens_index, std::string &frameName) const override
 Get the name of the frame of the specified sensor.
 
yarp::dev::ReturnValue getThreeAxisMagnetometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
 Get the last reading of the specified sensor.
 
yarp::dev::ReturnValue getNrOfPositionSensors (size_t &num) 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.
 
yarp::dev::ReturnValue getPositionSensorName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue getPositionSensorFrameName (size_t sens_index, std::string &frameName) const override
 Get the name of the frame of the specified sensor.
 
yarp::dev::ReturnValue 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.
 
yarp::dev::ReturnValue getNrOfLinearVelocitySensors (size_t &num) 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.
 
yarp::dev::ReturnValue getLinearVelocitySensorName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue getLinearVelocitySensorFrameName (size_t sens_index, std::string &frameName) const override
 Get the name of the frame of the specified sensor.
 
yarp::dev::ReturnValue 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.
 
yarp::dev::ReturnValue getNrOfOrientationSensors (size_t &num) 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.
 
yarp::dev::ReturnValue getOrientationSensorName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue getOrientationSensorFrameName (size_t sens_index, std::string &frameName) const override
 Get the name of the frame of the specified sensor.
 
yarp::dev::ReturnValue 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.
 
yarp::dev::ReturnValue getNrOfTemperatureSensors (size_t &num) 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.
 
yarp::dev::ReturnValue getTemperatureSensorName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue getTemperatureSensorFrameName (size_t sens_index, std::string &frameName) const override
 Get the name of the frame of the specified sensor.
 
yarp::dev::ReturnValue getTemperatureSensorMeasure (size_t sens_index, double &out, double &timestamp) const override
 Get the last reading of the specified sensor.
 
yarp::dev::ReturnValue getTemperatureSensorMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
 Get the last reading of the specified sensor.
 
yarp::dev::ReturnValue getNrOfSixAxisForceTorqueSensors (size_t &num) 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.
 
yarp::dev::ReturnValue getSixAxisForceTorqueSensorName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue getSixAxisForceTorqueSensorFrameName (size_t sens_index, std::string &frame) const override
 Get the name of the frame of the specified sensor.
 
yarp::dev::ReturnValue getSixAxisForceTorqueSensorMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
 Get the last reading of the specified sensor.
 
yarp::dev::ReturnValue getNrOfContactLoadCellArrays (size_t &num) 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.
 
yarp::dev::ReturnValue getContactLoadCellArrayName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue 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.
 
yarp::dev::ReturnValue getNrOfEncoderArrays (size_t &num) 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.
 
yarp::dev::ReturnValue getEncoderArrayName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue 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.
 
yarp::dev::ReturnValue getNrOfSkinPatches (size_t &num) 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.
 
yarp::dev::ReturnValue getSkinPatchName (size_t sens_index, std::string &name) const override
 Get the name of the specified sensor.
 
yarp::dev::ReturnValue 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.
 
bool getParamValue (const std::string &paramName, std::string &paramValue) const override
 Return the value (represented as a string) of the requested parameter.
 
std::string getConfiguration () const override
 Return the configuration of 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 = {}
 
std::string m_provided_configuration
 
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 47 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 122 of file MultipleAnalogSensorsClient.cpp.

◆ getContactLoadCellArrayMeasure()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getContactLoadCellArrayMeasure()-1).
[out]outThe requested measure. The vector should be getContactLoadCellArrayMeasure(sens_index)-dimensional. The measure is expressed in Newton.
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implements yarp::dev::IContactLoadCellArrays.

Definition at line 571 of file MultipleAnalogSensorsClient.cpp.

◆ getContactLoadCellArrayName()

ReturnValue 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 566 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 577 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 561 of file MultipleAnalogSensorsClient.cpp.

◆ getEncoderArrayMeasure()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfEncoderArrays()-1).
[out]outThe requested measure. The vector should be getEncoderArraySize(sens_index)-dimensional. The measure is expressed in Newton.
[out]timestampThe timestamp of the requested measure, expressed in seconds.

Implements yarp::dev::IEncoderArrays.

Definition at line 600 of file MultipleAnalogSensorsClient.cpp.

◆ getEncoderArrayName()

ReturnValue 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 595 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 606 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 590 of file MultipleAnalogSensorsClient.cpp.

◆ getLinearVelocitySensorFrameName()

ReturnValue 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 480 of file MultipleAnalogSensorsClient.cpp.

◆ getLinearVelocitySensorMeasure()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfLinearVelocitySensors()-1).
[out]outThe requested measure. The vector should be 3-dimensional. The measure is expressed in meters/second.
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implements yarp::dev::ILinearVelocitySensors.

Definition at line 485 of file MultipleAnalogSensorsClient.cpp.

◆ getLinearVelocitySensorName()

ReturnValue 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 475 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 470 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfContactLoadCellArrays()

ReturnValue MultipleAnalogSensorsClient::getNrOfContactLoadCellArrays ( size_t &  num) const
overridevirtual

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

Implements yarp::dev::IContactLoadCellArrays.

Definition at line 554 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfEncoderArrays()

ReturnValue MultipleAnalogSensorsClient::getNrOfEncoderArrays ( size_t &  num) const
overridevirtual

Get the number of encoder arrays exposed by this device.

Implements yarp::dev::IEncoderArrays.

Definition at line 583 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfLinearVelocitySensors()

ReturnValue MultipleAnalogSensorsClient::getNrOfLinearVelocitySensors ( size_t &  num) const
overridevirtual

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

Implements yarp::dev::ILinearVelocitySensors.

Definition at line 463 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfOrientationSensors()

ReturnValue MultipleAnalogSensorsClient::getNrOfOrientationSensors ( size_t &  num) const
overridevirtual

Get the number of orientation sensors exposed by this device.

Implements yarp::dev::IOrientationSensors.

Definition at line 408 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfPositionSensors()

ReturnValue MultipleAnalogSensorsClient::getNrOfPositionSensors ( size_t &  num) const
overridevirtual

Get the number of position sensors exposed by this device.

Implements yarp::dev::IPositionSensors.

Definition at line 436 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfSixAxisForceTorqueSensors()

ReturnValue MultipleAnalogSensorsClient::getNrOfSixAxisForceTorqueSensors ( size_t &  num) const
overridevirtual

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

Implements yarp::dev::ISixAxisForceTorqueSensors.

Definition at line 526 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfSkinPatches()

ReturnValue MultipleAnalogSensorsClient::getNrOfSkinPatches ( size_t &  num) const
overridevirtual

Get the number of skin patches exposed by this device.

Implements yarp::dev::ISkinPatches.

Definition at line 612 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfTemperatureSensors()

ReturnValue MultipleAnalogSensorsClient::getNrOfTemperatureSensors ( size_t &  num) const
overridevirtual

Get the number of temperature sensors exposed by this device.

Implements yarp::dev::ITemperatureSensors.

Definition at line 490 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfThreeAxisAngularAccelerometers()

ReturnValue MultipleAnalogSensorsClient::getNrOfThreeAxisAngularAccelerometers ( size_t &  num) const
overridevirtual

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

Implements yarp::dev::IThreeAxisAngularAccelerometers.

Definition at line 352 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfThreeAxisGyroscopes()

ReturnValue MultipleAnalogSensorsClient::getNrOfThreeAxisGyroscopes ( size_t &  num) const
overridevirtual

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

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 296 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfThreeAxisLinearAccelerometers()

ReturnValue MultipleAnalogSensorsClient::getNrOfThreeAxisLinearAccelerometers ( size_t &  num) const
overridevirtual

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

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 324 of file MultipleAnalogSensorsClient.cpp.

◆ getNrOfThreeAxisMagnetometers()

ReturnValue MultipleAnalogSensorsClient::getNrOfThreeAxisMagnetometers ( size_t &  num) const
overridevirtual

Get the number of magnetometers exposed by this device.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 380 of file MultipleAnalogSensorsClient.cpp.

◆ getOrientationSensorFrameName()

ReturnValue 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 425 of file MultipleAnalogSensorsClient.cpp.

◆ getOrientationSensorMeasureAsRollPitchYaw()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfOrientationSensors()-1).
[out]outThe requested measure. The vector should be 3-dimensional. The measure is expressed in degrees .
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implements yarp::dev::IOrientationSensors.

Definition at line 430 of file MultipleAnalogSensorsClient.cpp.

◆ getOrientationSensorName()

ReturnValue 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 420 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 415 of file MultipleAnalogSensorsClient.cpp.

◆ getPositionSensorFrameName()

ReturnValue 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 453 of file MultipleAnalogSensorsClient.cpp.

◆ getPositionSensorMeasure()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfPositionSensors()-1).
[out]outThe requested measure. The vector should be 3-dimensional. The measure is expressed in meters.
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implements yarp::dev::IPositionSensors.

Definition at line 458 of file MultipleAnalogSensorsClient.cpp.

◆ getPositionSensorName()

ReturnValue 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 448 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 443 of file MultipleAnalogSensorsClient.cpp.

◆ getSixAxisForceTorqueSensorFrameName()

ReturnValue 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 543 of file MultipleAnalogSensorsClient.cpp.

◆ getSixAxisForceTorqueSensorMeasure()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfSixAxisForceTorqueSensors()-1).
[out]outThe 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]timestampThe timestamp of the requested measure, expressed in seconds.

Implements yarp::dev::ISixAxisForceTorqueSensors.

Definition at line 548 of file MultipleAnalogSensorsClient.cpp.

◆ getSixAxisForceTorqueSensorName()

ReturnValue 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 538 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 533 of file MultipleAnalogSensorsClient.cpp.

◆ getSkinPatchMeasure()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfSkinPatches()-1).
[out]outThe requested measure. The vector should be getSkinPatchSize(sens_index)-dimensional. The measure is expressed in implementation-specific unit of measure.
[out]timestampThe timestamp of the requested measure, expressed in seconds.

Implements yarp::dev::ISkinPatches.

Definition at line 629 of file MultipleAnalogSensorsClient.cpp.

◆ getSkinPatchName()

ReturnValue 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 624 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 635 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 619 of file MultipleAnalogSensorsClient.cpp.

◆ getTemperatureSensorFrameName()

ReturnValue 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 507 of file MultipleAnalogSensorsClient.cpp.

◆ getTemperatureSensorMeasure() [1/2]

ReturnValue 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 518 of file MultipleAnalogSensorsClient.cpp.

◆ getTemperatureSensorMeasure() [2/2]

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfTemperatureSensors()-1).
[out]outThe requested measure. The vector should be 1-dimensional. The measure is expressed in celsius degrees .
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implements yarp::dev::ITemperatureSensors.

Definition at line 512 of file MultipleAnalogSensorsClient.cpp.

◆ getTemperatureSensorName()

ReturnValue 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 502 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 497 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisAngularAccelerometerFrameName()

ReturnValue 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 369 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisAngularAccelerometerMeasure()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisAngularAccelerometers()-1).
[out]outThe requested measure. The vector should be 3-dimensional. The measure is expressed in degrees^2/seconds.
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisAngularAccelerometers.

Definition at line 374 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisAngularAccelerometerName()

ReturnValue 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 364 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 359 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisGyroscopeFrameName()

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

Get the name of the frame of the specified sensor.

Parameters
[in]sens_indexThe 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 313 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisGyroscopeMeasure()

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

Get the last reading of the gyroscope.

Parameters
[in]sens_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).
[out]outThe requested measure. The vector should be 3-dimensional. The measure is expressed in degrees/seconds.
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 318 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisGyroscopeName()

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

Get the name of the specified sensor.

Parameters
[in]sens_indexThe 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 308 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_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 303 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisLinearAccelerometerFrameName()

ReturnValue 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 341 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisLinearAccelerometerMeasure()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisLinearAccelerometers()-1).
[out]outThe requested measure. The vector should be 3-dimensional. The measure is expressed in meters^2/seconds.
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 346 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisLinearAccelerometerName()

ReturnValue 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 336 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 331 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisMagnetometerFrameName()

ReturnValue 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 397 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisMagnetometerMeasure()

ReturnValue 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_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisMagnetometers()-1).
[out]outThe requested measure. The vector should be 3-dimensional. The measure is expressed in tesla .
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 402 of file MultipleAnalogSensorsClient.cpp.

◆ getThreeAxisMagnetometerName()

ReturnValue 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 392 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 387 of file MultipleAnalogSensorsClient.cpp.

◆ open()

bool MultipleAnalogSensorsClient::open ( yarp::os::Searchable &  config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. 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 42 of file MultipleAnalogSensorsClient.cpp.


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