upkie 6.1.0
Open-source wheeled biped robots
Loading...
Searching...
No Matches
upkie::cpp::spine::StateMachine Class Reference

Spine state machine. More...

#include <StateMachine.h>

Public Member Functions

 StateMachine (AgentInterface &interface) noexcept
 Initialize state machine. More...
 
void process_event (const Event &event) noexcept
 Process a new event. More...
 
const Statestate () const noexcept
 Get current state.
 
bool is_over_after_this_cycle () const noexcept
 Whether we transition to the terminal state at the next end-cycle event.
 

Detailed Description

Spine state machine.

The overall specification of the state machine is summarized in the following diagram:

See Spine state machine for an overview of this state machine.

Constructor & Destructor Documentation

◆ StateMachine()

upkie::cpp::spine::StateMachine::StateMachine ( AgentInterface interface)
explicitnoexcept

Initialize state machine.

Parameters
[in]interfaceInterface to communicate with the agent.

Member Function Documentation

◆ process_event()

void upkie::cpp::spine::StateMachine::process_event ( const Event event)
noexcept

Process a new event.

Parameters
[in]eventNew event.

The documentation for this class was generated from the following files: