rcl_action  master
C API providing common functionality for ROS actions.
Functions
goal_state_machine.h File Reference
#include "rcl_action/types.h"
#include "rcl_action/visibility_control.h"
Include dependency graph for goal_state_machine.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

RCL_ACTION_PUBLIC rcl_action_goal_state_t rcl_action_transition_goal_state (const rcl_action_goal_state_t state, const rcl_action_goal_event_t event)
 Transition a goal from one state to the next. More...
 

Function Documentation

◆ rcl_action_transition_goal_state()

RCL_ACTION_PUBLIC rcl_action_goal_state_t rcl_action_transition_goal_state ( const rcl_action_goal_state_t  state,
const rcl_action_goal_event_t  event 
)

Transition a goal from one state to the next.

Given a goal state and a goal event, return the next state.

Parameters
[in]statethe state to transition from
[in]eventthe event triggering a transition
Returns
the next goal state if the transition is valid, or
GOAL_STATE_UNKNOWN if the transition is invalid or an error occured