arbitrator_state_machine.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2022 LEIDOS.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
 
#ifndef __ARBITRATOR_INCLUDE_ARBITRATOR_STATE_MACHINE_HPP__
#define __ARBITRATOR_INCLUDE_ARBITRATOR_STATE_MACHINE_HPP__
 
#include <vector>
 
namespace arbitrator
{
    enum ArbitratorState {
        INITIAL = 0,
        PLANNING,
        WAITING,
        PAUSED,
        SHUTDOWN
    };
 
    enum ArbitratorEvent {
        SYSTEM_STARTUP_COMPLETE = 0,
        PLANNING_COMPLETE,
        PLANNING_TIMER_TRIGGER,
        ARBITRATOR_PAUSED,
        ARBITRATOR_RESUMED,
        SYSTEM_SHUTDOWN_INITIATED
    };
 
    struct ArbitratorStateTransition {
        ArbitratorState current_state;
        ArbitratorEvent input_event;
        ArbitratorState final_state;
    };
 
 
    class ArbitratorStateMachine
    {
        public:
            ArbitratorStateMachine() : 
                current_state(INITIAL){};
            ArbitratorState submit_event(ArbitratorEvent event);
 
            ArbitratorState get_state();
 
        private:
            const std::vector<ArbitratorStateTransition> ARBITRATOR_TRANSITIONS =
            {   
                // Nominal arbitrator functionality
                {INITIAL, SYSTEM_STARTUP_COMPLETE, PLANNING},
                {PLANNING, PLANNING_COMPLETE, WAITING},
                {WAITING, PLANNING_TIMER_TRIGGER, PLANNING},
                
                // Interrupt and resume
                {PLANNING, ARBITRATOR_PAUSED, PAUSED},
                {WAITING, ARBITRATOR_PAUSED, PAUSED},
                {PAUSED, ARBITRATOR_RESUMED, PLANNING},
 
                // System shutdown procedures
                {INITIAL, SYSTEM_SHUTDOWN_INITIATED, SHUTDOWN},
                {PLANNING, SYSTEM_SHUTDOWN_INITIATED, SHUTDOWN},
                {WAITING, SYSTEM_SHUTDOWN_INITIATED, SHUTDOWN},
                {PAUSED, SYSTEM_SHUTDOWN_INITIATED, SHUTDOWN},
            };
 
            ArbitratorState current_state;
    };
}
 
#endif