GlobalRobotPoseSensorDevice Class Reference

#include <RobotAPI/components/units/RobotUnit/Devices/GlobalRobotPoseSensorDevice.h>

Inheritance diagram for GlobalRobotPoseSensorDevice:

Public Types
using	SensorValueType = SensorValueGlobalRobotPose

Public Member Functions
std::string	getReportingFrame () const override
const SensorValueBase *	getSensorValue () const override
	GlobalRobotPoseSensorDevice ()
void	rtReadSensorValues (const IceUtil::Time &sensorValuesTimestamp, const IceUtil::Time &timeSinceLastIteration) override
	This is a hook for implementations to read the sensor value from a bus.
Public Member Functions inherited from SensorDevice
template<class T>
const T *	getSensorValue () const
std::string	getSensorValueType (bool withoutNamespaceSpecifier=false) const
	Returns the SensorValue's type as a string.
	SensorDevice (const std::string &name)
	Create a SensorDevice with the given name.
Public Member Functions inherited from DeviceBase
	DeviceBase (const std::string &name)
	Create a Device with the given name.
const std::string &	getDeviceName () const
const std::set< std::string > &	getTags () const
virtual bool	hasError ()
bool	hasTag (const std::string &tag) const
const char *	rtGetDeviceName () const
virtual	~DeviceBase ()=default

Static Public Member Functions
static std::string	DeviceName ()

Protected Attributes
SensorValueType	sensor

Additional Inherited Members
Static Public Attributes inherited from SensorDevice
static const SensorDevicePtr	NullPtr {nullptr}
	A static const nullptr in case a const ref to a nullptr needs to be returned.
Protected Member Functions inherited from DeviceBase
void	addDeviceTag (const std::string &tag)
	adds the given tag to the Device

Member Typedef Documentation

SensorValueType

using SensorValueType = SensorValueGlobalRobotPose

Constructor & Destructor Documentation

GlobalRobotPoseSensorDevice()

GlobalRobotPoseSensorDevice

(

)

Member Function Documentation

DeviceName()

std::string DeviceName ( )

static

getReportingFrame()

std::string getReportingFrame ( ) const

overridevirtual

Returns

The reporting frame name of this sensor (e.g. The frame some force torque values are in). This may be empty for virtual sensors e.g. execution time sensors.

Reimplemented from SensorDevice.

getSensorValue()

const SensorValueBase * getSensorValue ( ) const

overridevirtual

Returns

The SensorDevice's sensor value

Implements SensorDevice.

rtReadSensorValues()

void rtReadSensorValues ( const IceUtil::Time & sensorValuesTimestamp, const IceUtil::Time & timeSinceLastIteration )

overridevirtual

This is a hook for implementations to read the sensor value from a bus.

Parameters

sensorValuesTimestamp	The current timestamp
timeSinceLastIteration	The time delta since the last call

Reimplemented from SensorDevice.

Member Data Documentation

sensor

SensorValueType sensor

protected

---

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

• RobotAPI/components/units/RobotUnit/Devices/GlobalRobotPoseSensorDevice.h
• RobotAPI/components/units/RobotUnit/Devices/GlobalRobotPoseSensorDevice.cpp