ROS2::ITimeSource Class Reference

Interface for time source used by ROS2ClockSystemComponent. More...

#include <ITimeSource.h>

Inherited by ROS2::ROS2TimeSource, ROS2::RealTimeSource, and ROS2::SimulationTimeSource.

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

Detailed Description

Interface for time source used by ROS2ClockSystemComponent.

Member Function Documentation

AdjustTime()

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

pure virtual

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.

Implemented in ROS2::RealTimeSource, ROS2::ROS2TimeSource, and ROS2::SimulationTimeSource.

GetROSTimestamp()

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

pure virtual

Get time as ROS 2 message.

See also

ROS2Requests::GetROSTimestamp() for more details.

Implemented in ROS2::RealTimeSource, ROS2::ROS2TimeSource, and ROS2::SimulationTimeSource.

---

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

• Gems/ROS2/Code/Source/Clock/ITimeSource.h