RTThreadTimingsSensorDeviceImpl< SensorValueType > Class Template Reference

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

+ Inheritance diagram for RTThreadTimingsSensorDeviceImpl< SensorValueType >:

Public Member Functions

const SensorValueBasegetSensorValue () const override
 
void rtMarkRtBusSendReceiveEnd () override
 
void rtMarkRtBusSendReceiveStart () override
 
void rtMarkRtLoopPreSleep () override
 
void rtMarkRtLoopStart () override
 
 RTThreadTimingsSensorDeviceImpl (const std::string &name)
 
- Public Member Functions inherited from RTThreadTimingsSensorDevice
 RTThreadTimingsSensorDevice (const std::string &name)
 
- Public Member Functions inherited from SensorDevice
virtual std::string getReportingFrame () const
 
template<class T >
const TgetSensorValue () const
 
std::string getSensorValueType (bool withoutNamespaceSpecifier=false) const
 Returns the SensorValue's type as a string. More...
 
virtual void rtReadSensorValues (const IceUtil::Time &sensorValuesTimestamp, const IceUtil::Time &timeSinceLastIteration)
 This is a hook for implementations to read the sensor value from a bus. 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
 
bool hasTag (const std::string &tag) const
 
const char * rtGetDeviceName () const
 
virtual ~DeviceBase ()=default
 

Public Attributes

SensorValueType value
 

Protected Member Functions

 make_markRT_X_Start_End (HandleInvalidTargets)
 
 make_markRT_X_Start_End (ReadSensorDeviceValues)
 
 make_markRT_X_Start_End (ResetAllTargets)
 
 make_markRT_X_Start_End (RunJointControllers)
 
 make_markRT_X_Start_End (RunNJointControllers)
 
 make_markRT_X_Start_End (SwitchControllerSetup)
 
 make_markRT_X_Start_End (UpdateSensorAndControlBuffer)
 
- Protected Member Functions inherited from RTThreadTimingsSensorDevice
virtual void rtMarkRtHandleInvalidTargetsEnd ()=0
 
virtual void rtMarkRtHandleInvalidTargetsStart ()=0
 
virtual void rtMarkRtReadSensorDeviceValuesEnd ()=0
 
virtual void rtMarkRtReadSensorDeviceValuesStart ()=0
 
virtual void rtMarkRtResetAllTargetsEnd ()=0
 
virtual void rtMarkRtResetAllTargetsStart ()=0
 
virtual void rtMarkRtRunJointControllersEnd ()=0
 
virtual void rtMarkRtRunJointControllersStart ()=0
 
virtual void rtMarkRtRunNJointControllersEnd ()=0
 
virtual void rtMarkRtRunNJointControllersStart ()=0
 
virtual void rtMarkRtSwitchControllerSetupEnd ()=0
 
virtual void rtMarkRtSwitchControllerSetupStart ()=0
 
virtual void rtMarkRtUpdateSensorAndControlBufferEnd ()=0
 
virtual void rtMarkRtUpdateSensorAndControlBufferStart ()=0
 
- Protected Member Functions inherited from DeviceBase
void addDeviceTag (const std::string &tag)
 adds the given tag to the Device More...
 

Protected Attributes

IceUtil::Time rtBusSendReceiveStart
 
IceUtil::Time rtHandleInvalidTargetsStart
 
IceUtil::Time rtLoopStart
 
IceUtil::Time rtReadSensorDeviceValuesStart
 
IceUtil::Time rtResetAllTargetsStart
 
IceUtil::Time rtRunJointControllersStart
 
IceUtil::Time rtRunNJointControllersStart
 
IceUtil::Time rtSwitchControllerSetupStart
 
IceUtil::Time rtUpdateSensorAndControlBufferStart
 

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

Detailed Description

template<class SensorValueType = SensorValueRTThreadTimings>
class armarx::RTThreadTimingsSensorDeviceImpl< SensorValueType >

Definition at line 81 of file RTThreadTimingsSensorDevice.h.

Constructor & Destructor Documentation

◆ RTThreadTimingsSensorDeviceImpl()

RTThreadTimingsSensorDeviceImpl ( const std::string &  name)
inline

Definition at line 88 of file RTThreadTimingsSensorDevice.h.

Member Function Documentation

◆ getSensorValue()

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

Implements RTThreadTimingsSensorDevice.

Definition at line 94 of file RTThreadTimingsSensorDevice.h.

◆ make_markRT_X_Start_End() [1/7]

make_markRT_X_Start_End ( HandleInvalidTargets  )
protected

◆ make_markRT_X_Start_End() [2/7]

make_markRT_X_Start_End ( ReadSensorDeviceValues  )
protected

◆ make_markRT_X_Start_End() [3/7]

make_markRT_X_Start_End ( ResetAllTargets  )
protected

◆ make_markRT_X_Start_End() [4/7]

make_markRT_X_Start_End ( RunJointControllers  )
protected

◆ make_markRT_X_Start_End() [5/7]

make_markRT_X_Start_End ( RunNJointControllers  )
protected

◆ make_markRT_X_Start_End() [6/7]

make_markRT_X_Start_End ( SwitchControllerSetup  )
protected

◆ make_markRT_X_Start_End() [7/7]

make_markRT_X_Start_End ( UpdateSensorAndControlBuffer  )
protected

◆ rtMarkRtBusSendReceiveEnd()

void rtMarkRtBusSendReceiveEnd ( )
inlineoverridevirtual

Implements RTThreadTimingsSensorDevice.

Definition at line 124 of file RTThreadTimingsSensorDevice.h.

+ Here is the call graph for this function:

◆ rtMarkRtBusSendReceiveStart()

void rtMarkRtBusSendReceiveStart ( )
inlineoverridevirtual

Implements RTThreadTimingsSensorDevice.

Definition at line 116 of file RTThreadTimingsSensorDevice.h.

+ Here is the call graph for this function:

◆ rtMarkRtLoopPreSleep()

void rtMarkRtLoopPreSleep ( )
inlineoverridevirtual

Implements RTThreadTimingsSensorDevice.

Definition at line 110 of file RTThreadTimingsSensorDevice.h.

+ Here is the call graph for this function:

◆ rtMarkRtLoopStart()

void rtMarkRtLoopStart ( )
inlineoverridevirtual

Implements RTThreadTimingsSensorDevice.

Definition at line 102 of file RTThreadTimingsSensorDevice.h.

+ Here is the call graph for this function:

Member Data Documentation

◆ rtBusSendReceiveStart

IceUtil::Time rtBusSendReceiveStart
protected

Definition at line 157 of file RTThreadTimingsSensorDevice.h.

◆ rtHandleInvalidTargetsStart

IceUtil::Time rtHandleInvalidTargetsStart
protected

Definition at line 155 of file RTThreadTimingsSensorDevice.h.

◆ rtLoopStart

IceUtil::Time rtLoopStart
protected

Definition at line 161 of file RTThreadTimingsSensorDevice.h.

◆ rtReadSensorDeviceValuesStart

IceUtil::Time rtReadSensorDeviceValuesStart
protected

Definition at line 158 of file RTThreadTimingsSensorDevice.h.

◆ rtResetAllTargetsStart

IceUtil::Time rtResetAllTargetsStart
protected

Definition at line 160 of file RTThreadTimingsSensorDevice.h.

◆ rtRunJointControllersStart

IceUtil::Time rtRunJointControllersStart
protected

Definition at line 156 of file RTThreadTimingsSensorDevice.h.

◆ rtRunNJointControllersStart

IceUtil::Time rtRunNJointControllersStart
protected

Definition at line 154 of file RTThreadTimingsSensorDevice.h.

◆ rtSwitchControllerSetupStart

IceUtil::Time rtSwitchControllerSetupStart
protected

Definition at line 153 of file RTThreadTimingsSensorDevice.h.

◆ rtUpdateSensorAndControlBufferStart

IceUtil::Time rtUpdateSensorAndControlBufferStart
protected

Definition at line 159 of file RTThreadTimingsSensorDevice.h.

◆ value

SensorValueType value

Definition at line 99 of file RTThreadTimingsSensorDevice.h.


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