ROS2::RealTimeSource Class Reference

#include <RealTimeSource.h>

Inherits ROS2::ITimeSource.

Public Member Functions
virtual void	Activate () override
virtual void	Deactivate () override
virtual AZ::Outcome< void, AZStd::string >	AdjustTime (const builtin_interfaces::msg::Time &time) override
virtual builtin_interfaces::msg::Time	GetROSTimestamp () const override

Detailed Description

The RealTimeSource starts from 0 at the start of the simulation. This time source could be affected by the jitter in the data, simulation computations or other similar events. On the other hand RealTimeSource can remain consistent with the other independent clocks if it is synchronized (e.g. through NTP).

Member Function Documentation

Activate()

virtual void ROS2::RealTimeSource::Activate ( )

inlineoverridevirtual

Implements ROS2::ITimeSource.

AdjustTime()

virtual AZ::Outcome< void, AZStd::string > ROS2::RealTimeSource::AdjustTime ( const builtin_interfaces::msg::Time &  time )

overridevirtual

Sets the time source to the given time.

Parameters

time	The time to set the time source to.

Returns

An outcome indicating success or failure.

Implements ROS2::ITimeSource.

Deactivate()

virtual void ROS2::RealTimeSource::Deactivate ( )

inlineoverridevirtual

Implements ROS2::ITimeSource.

GetROSTimestamp()

virtual builtin_interfaces::msg::Time ROS2::RealTimeSource::GetROSTimestamp ( ) const

overridevirtual

Get simulation time as ROS 2 message.

See also

ROS2Requests::GetROSTimestamp() for more details.

Implements ROS2::ITimeSource.

---

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

• Gems/ROS2/Code/Include/ROS2/Clock/RealTimeSource.h