Open 3D Engine ROS2 Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
ROS2::SimulationClock Class Reference

Simulation clock which can tick and serve time stamps. More...

#include <SimulationClock.h>

Public Member Functions

builtin_interfaces::msg::Time GetROSTimestamp () const
 
void Tick ()
 
AZStd::chrono::duration< float,
AZStd::chrono::seconds::period > 		GetExpectedSimulationLoopTime () const
 Returns an expected loop time of simulation. It is an estimation from past frames.
 
builtin_interfaces::msg::Time GetROSTimestamp () const
 
void Tick ()
 

Detailed Description

Simulation clock which can tick and serve time stamps.

Member Function Documentation

builtin_interfaces::msg::Time ROS2::SimulationClock::GetROSTimestamp ( ) const

Get simulation time as ROS2 message.

See Also
ROS2Requests::GetROSTimestamp() for more details.
builtin_interfaces::msg::Time ROS2::SimulationClock::GetROSTimestamp ( ) const

Get simulation time as ROS2 message.

See Also
ROS2Requests::GetROSTimestamp() for more details.
void ROS2::SimulationClock::Tick ( )

Update time in the ROS 2 ecosystem. This will publish current time to the ROS 2 /clock topic.

void ROS2::SimulationClock::Tick ( )

Update time in the ROS 2 ecosystem. This will publish current time to the ROS 2 /clock topic.

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