Open 3D Engine ROS2 Gem API Reference  24.09
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::ROS2Clock Class Reference

#include <ROS2Clock.h>

Public Member Functions

 ROS2Clock (AZStd::unique_ptr< ITimeSource > timeSource, bool publishClock)
 
void Activate ()
 
void Deactivate ()
 
builtin_interfaces::msg::Time GetROSTimestamp () const
 
void Tick ()
 

Detailed Description

The ROS2Clock provides ROS timestamps as builtin_interface::msg::Time messages. The clock can use different types of the time sources and publish the current time to the ROS 2 /clock/ topic. The published time can be used with the /use_sim_time parameter set to true.

Member Function Documentation

◆ Tick()

void ROS2::ROS2Clock::Tick ( )

Update time in the ROS 2 ecosystem. This will publish current time to the ROS 2 /clock topic, if Clock is configured to do it.

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