Function rcl_lifecycle_state_machine_is_initialized

Defined in File rcl_lifecycle.h

Function Documentation

rcl_ret_t rcl_lifecycle_state_machine_is_initialized(const rcl_lifecycle_state_machine_t *state_machine)

Check if a state machine is active.

If the state is initialized then returns RCL_RET_OK, otherwise returns RCL_RET_ERROR In the case where RCL_RET_ERROR is to be returned, an error message is set. This function cannot fail.

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

Parameters:: state_machine – [in] pointer to the state machine struct
Returns:: RCL_RET_OK if the state is initialized, or
Returns:: RCL_RET_INVALID_ARGUMENT if any arguments are invalid.