arbitrator::ArbitratorStateMachine Class Reference

#include <arbitrator_state_machine.hpp>

Collaboration diagram for arbitrator::ArbitratorStateMachine:

Public Member Functions
	ArbitratorStateMachine ()
ArbitratorState	submit_event (ArbitratorEvent event)
ArbitratorState	get_state ()

Private Attributes
const std::vector< ArbitratorStateTransition >	ARBITRATOR_TRANSITIONS
ArbitratorState	current_state

Detailed Description

The ArbitratorStateMachine class is responsible for regulating the state transitions within the Arbitrator node. It processess events and correlates them against a list of legal transitions to generate the next state the Arbitrator will take. The transition list is defined internally and each transition must be unique/deterministic (each state/event pair must transition to one-and-only-one other state) or behavior is undefined.

Definition at line 74 of file arbitrator_state_machine.hpp.

Constructor & Destructor Documentation

ArbitratorStateMachine()

arbitrator::ArbitratorStateMachine::ArbitratorStateMachine ( )

inline

Definition at line 77 of file arbitrator_state_machine.hpp.

                                     : 
                current_state(INITIAL){};

Member Function Documentation

get_state()

ArbitratorState arbitrator::ArbitratorStateMachine::get_state

(

)

Get the current state of the Arbitrator

Returns

The state of the Arbitrator

Definition at line 23 of file arbitrator_state_machine.cpp.

    {
        return current_state;        
    }

References current_state.

submit_event()

ArbitratorState arbitrator::ArbitratorStateMachine::submit_event

(

ArbitratorEvent

event

)

Submit an event for evaluation by the Arbitrator state machine.

Parameters

The	event to process

Returns

The state of the Arbitrator after the event has been processed.

Definition at line 29 of file arbitrator_state_machine.cpp.

    {
        for (auto pair : ARBITRATOR_TRANSITIONS) 
        {
            if (current_state == pair.current_state && event == pair.input_event) 
            {
                // In the event of multiple legal transistions this will take the last transition,
                // But ultimately this condition should never arise.
                current_state = pair.final_state;
                break;
            }
        }
 
        return current_state;
    }

References ARBITRATOR_TRANSITIONS, and current_state.

Member Data Documentation

ARBITRATOR_TRANSITIONS

const std::vector<ArbitratorStateTransition> arbitrator::ArbitratorStateMachine::ARBITRATOR_TRANSITIONS

private

Initial value:

=
            {   
                
                {INITIAL, SYSTEM_STARTUP_COMPLETE, PLANNING},
                {PLANNING, PLANNING_COMPLETE, WAITING},
                {WAITING, PLANNING_TIMER_TRIGGER, PLANNING},
                
                
                {PLANNING, ARBITRATOR_PAUSED, PAUSED},
                {WAITING, ARBITRATOR_PAUSED, PAUSED},
                {PAUSED, ARBITRATOR_RESUMED, PLANNING},
 
                
                {INITIAL, SYSTEM_SHUTDOWN_INITIATED, SHUTDOWN},
                {PLANNING, SYSTEM_SHUTDOWN_INITIATED, SHUTDOWN},
                {WAITING, SYSTEM_SHUTDOWN_INITIATED, SHUTDOWN},
                {PAUSED, SYSTEM_SHUTDOWN_INITIATED, SHUTDOWN},
            }

Private, fixed state transition table

Definition at line 96 of file arbitrator_state_machine.hpp.

Referenced by submit_event().

current_state

ArbitratorState arbitrator::ArbitratorStateMachine::current_state

private

Definition at line 115 of file arbitrator_state_machine.hpp.

Referenced by get_state(), and submit_event().

---

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

• arbitrator/include/arbitrator_state_machine.hpp
• arbitrator/src/arbitrator_state_machine.cpp