niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document clock types (#578)

Browse source 
Resolves #552

Signed-off-by: Jacob Perron <jacob@openrobotics.org>
This commit is contained in:
Jacob Perron 2020-03-02 22:20:58 +01:00 • committed by GitHub
parent 74a1e7f228
commit ca64525029
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
rcl/include/rcl/time.h
View file

@ -46,6 +46,16 @@ typedef rcutils_time_point_value_t rcl_time_point_value_t;
typedef rcutils_duration_value_t rcl_duration_value_t; typedef rcutils_duration_value_t rcl_duration_value_t;
/// Time source type, used to indicate the source of a time measurement. /// Time source type, used to indicate the source of a time measurement.
/**
* RCL_ROS_TIME will report the latest value reported by a ROS time source, or
* if a ROS time source is not active it reports the same as RCL_SYSTEM_TIME.
* For more information about ROS time sources, refer to the design document:
* http://design.ros2.org/articles/clock_and_time.html
*
* RCL_SYSTEM_TIME reports the same value as the system clock.
*
* RCL_STEADY_TIME reports a value from a monotonically increasing clock.
*/
typedef enum rcl_clock_type_t typedef enum rcl_clock_type_t
{ {
RCL_CLOCK_UNINITIALIZED = 0, RCL_CLOCK_UNINITIALIZED = 0,