GlobalRobotPoseCorrectionSensorDevice Class Reference

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

+ Inheritance diagram for GlobalRobotPoseCorrectionSensorDevice:

Public Types

using SensorValueType = SensorValueGlobalPoseCorrection
 

Public Member Functions

std::string getReportingFrame () const override
 
const SensorValueBasegetSensorValue () const override
 
 GlobalRobotPoseCorrectionSensorDevice ()
 
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. More...
 
void updateGlobalPositionCorrection (const SensorValueType::Transformation &global_T_odom)
 
- Public Member Functions inherited from SensorDevice
template<class T >
const TgetSensorValue () const
 
std::string getSensorValueType (bool withoutNamespaceSpecifier=false) const
 Returns the SensorValue's type as a string. More...
 
 SensorDevice (const std::string &name)
 Create a SensorDevice with the given name. More...
 
- Public Member Functions inherited from DeviceBase
 DeviceBase (const std::string &name)
 Create a Device with the given name. More...
 
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 ()
 

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. More...
 
- Protected Member Functions inherited from DeviceBase
void addDeviceTag (const std::string &tag)
 adds the given tag to the Device More...
 

Detailed Description

Definition at line 56 of file GlobalRobotPoseSensorDevice.h.

Member Typedef Documentation

◆ SensorValueType

Constructor & Destructor Documentation

◆ GlobalRobotPoseCorrectionSensorDevice()

Definition at line 45 of file GlobalRobotPoseSensorDevice.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ DeviceName()

std::string DeviceName ( )
static

Definition at line 40 of file GlobalRobotPoseSensorDevice.cpp.

+ Here is the caller graph for this function:

◆ 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.

Definition at line 58 of file GlobalRobotPoseSensorDevice.cpp.

◆ getSensorValue()

const SensorValueBase * getSensorValue ( ) const
overridevirtual
Returns
The SensorDevice's sensor value

Implements SensorDevice.

Definition at line 52 of file GlobalRobotPoseSensorDevice.cpp.

◆ 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
sensorValuesTimestampThe current timestamp
timeSinceLastIterationThe time delta since the last call

Reimplemented from SensorDevice.

Definition at line 64 of file GlobalRobotPoseSensorDevice.cpp.

+ Here is the call graph for this function:

◆ updateGlobalPositionCorrection()

void updateGlobalPositionCorrection ( const SensorValueType::Transformation global_T_odom)

Definition at line 72 of file GlobalRobotPoseSensorDevice.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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