List of all members | Public Member Functions | Protected Member Functions | Friends
RTThreadTimingsSensorDevice Class Referenceabstract

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

+ Inheritance diagram for RTThreadTimingsSensorDevice:

Public Member Functions

const SensorValueBase * getSensorValue () const override=0
 
virtual void rtMarkRtBusSendReceiveEnd ()=0
 
virtual void rtMarkRtBusSendReceiveStart ()=0
 
virtual void rtMarkRtLoopPreSleep ()=0
 
virtual void rtMarkRtLoopStart ()=0
 
 RTThreadTimingsSensorDevice (const std::string &name)
 
- Public Member Functions inherited from SensorDevice
virtual std::string getReportingFrame () const
 
template<class T >
const T * getSensorValue () 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
 

Protected Member Functions

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

Friends

class RobotUnit
 
class RobotUnitModule::ControlThread
 

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

Definition at line 38 of file RTThreadTimingsSensorDevice.h.

Constructor & Destructor Documentation

◆ RTThreadTimingsSensorDevice()

RTThreadTimingsSensorDevice ( const std::string &  name)
inline

Definition at line 41 of file RTThreadTimingsSensorDevice.h.

Member Function Documentation

◆ getSensorValue()

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

Implements SensorDevice.

Implemented in RTThreadTimingsSensorDeviceImpl< SensorValueType >.

◆ rtMarkRtBusSendReceiveEnd()

virtual void rtMarkRtBusSendReceiveEnd ( )
pure virtual

Implemented in RTThreadTimingsSensorDeviceImpl< SensorValueType >.

+ Here is the caller graph for this function:

◆ rtMarkRtBusSendReceiveStart()

virtual void rtMarkRtBusSendReceiveStart ( )
pure virtual

Implemented in RTThreadTimingsSensorDeviceImpl< SensorValueType >.

+ Here is the caller graph for this function:

◆ rtMarkRtHandleInvalidTargetsEnd()

virtual void rtMarkRtHandleInvalidTargetsEnd ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtHandleInvalidTargetsStart()

virtual void rtMarkRtHandleInvalidTargetsStart ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtLoopPreSleep()

virtual void rtMarkRtLoopPreSleep ( )
pure virtual

Implemented in RTThreadTimingsSensorDeviceImpl< SensorValueType >.

+ Here is the caller graph for this function:

◆ rtMarkRtLoopStart()

virtual void rtMarkRtLoopStart ( )
pure virtual

Implemented in RTThreadTimingsSensorDeviceImpl< SensorValueType >.

+ Here is the caller graph for this function:

◆ rtMarkRtReadSensorDeviceValuesEnd()

virtual void rtMarkRtReadSensorDeviceValuesEnd ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtReadSensorDeviceValuesStart()

virtual void rtMarkRtReadSensorDeviceValuesStart ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtResetAllTargetsEnd()

virtual void rtMarkRtResetAllTargetsEnd ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtResetAllTargetsStart()

virtual void rtMarkRtResetAllTargetsStart ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtRunJointControllersEnd()

virtual void rtMarkRtRunJointControllersEnd ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtRunJointControllersStart()

virtual void rtMarkRtRunJointControllersStart ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtRunNJointControllersEnd()

virtual void rtMarkRtRunNJointControllersEnd ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtRunNJointControllersStart()

virtual void rtMarkRtRunNJointControllersStart ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtSwitchControllerSetupEnd()

virtual void rtMarkRtSwitchControllerSetupEnd ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtSwitchControllerSetupStart()

virtual void rtMarkRtSwitchControllerSetupStart ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtUpdateSensorAndControlBufferEnd()

virtual void rtMarkRtUpdateSensorAndControlBufferEnd ( )
protectedpure virtual
+ Here is the caller graph for this function:

◆ rtMarkRtUpdateSensorAndControlBufferStart()

virtual void rtMarkRtUpdateSensorAndControlBufferStart ( )
protectedpure virtual
+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ RobotUnit

friend class RobotUnit
friend

Definition at line 54 of file RTThreadTimingsSensorDevice.h.

◆ RobotUnitModule::ControlThread

friend class RobotUnitModule::ControlThread
friend

Definition at line 55 of file RTThreadTimingsSensorDevice.h.

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