Function rcl_clock_valid

• Defined in File time.h

Function Documentation

bool rcl_clock_valid(rcl_clock_t *clock)

Check if the clock has valid values.

This function returns true if the time source appears to be valid. It will check that the type is not uninitialized, and that pointers are not invalid. Note that if data is uninitialized it may give a false positive.

Attribute	Adherence
Allocates Memory	No
Thread-Safe	Yes
Uses Atomics	No
Lock-Free	Yes

Parameters:

clock – [in] the handle to the clock which is being queried

Returns:

true if the source is believed to be valid, otherwise return false.