Open 3D Engine ROS2 Gem API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ROS2::ITimeSource Class Referenceabstract

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
 

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
timeThe 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: