Function rcl_disable_ros_time_override

• Defined in File time.h

Function Documentation

rcl_ret_t rcl_disable_ros_time_override(rcl_clock_t *clock)

Disable the ROS time abstraction override.

This method will disable the RCL_ROS_TIME time abstraction override values, such that the time source will report the system time even if a custom value has been set.

This function is not thread-safe with rcl_clock_add_jump_callback(), nor rcl_clock_remove_jump_callback() functions when used on the same clock object.

Attribute	Adherence [1]
Allocates Memory	No
Thread-Safe	No [2]
Uses Atomics	No
Lock-Free	Yes

[1] Only applies to the function itself, as jump callbacks may not abide to it. [2] Function is reentrant, but concurrent calls on the same object are not safe.

Parameters:

clock – [in] The clock to disable.

Returns:

RCL_RET_OK if the time source was disabled successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR an unspecified error occur.