PluginState.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// 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 OPENSWMM_PLUGIN_STATE_HPP
#define OPENSWMM_PLUGIN_STATE_HPP
 
#include <cstdint>
 
namespace openswmm {

enum class PluginState : std::int32_t {
    UNLOADED    =  0, 
    LOADED      =  1, 
    INITIALIZED =  2, 
    VALIDATED   =  3, 
    PREPARED    =  4, 
    UPDATING    =  5, 
    FINALIZED   =  6, 
    CLOSED      =  7, 
    ERROR       = -1  
};

inline const char* plugin_state_to_string(PluginState state) noexcept {
    switch (state) {
        case PluginState::UNLOADED:    return "UNLOADED";
        case PluginState::LOADED:      return "LOADED";
        case PluginState::INITIALIZED: return "INITIALIZED";
        case PluginState::VALIDATED:   return "VALIDATED";
        case PluginState::PREPARED:    return "PREPARED";
        case PluginState::UPDATING:    return "UPDATING";
        case PluginState::FINALIZED:   return "FINALIZED";
        case PluginState::CLOSED:      return "CLOSED";
        case PluginState::ERROR:       return "ERROR";
        default:                       return "UNKNOWN";
    }
}

inline bool plugin_state_transition_valid(PluginState from, PluginState to) noexcept {
    using PS = PluginState;
    if (to == PS::ERROR) return true;   // any state can transition to ERROR
    switch (from) {
        case PS::UNLOADED:    return to == PS::LOADED;
        case PS::LOADED:      return to == PS::INITIALIZED || to == PS::CLOSED;
        case PS::INITIALIZED: return to == PS::VALIDATED   || to == PS::CLOSED;
        case PS::VALIDATED:   return to == PS::PREPARED    || to == PS::CLOSED;
        case PS::PREPARED:    return to == PS::UPDATING    || to == PS::FINALIZED;
        case PS::UPDATING:    return to == PS::PREPARED;
        case PS::FINALIZED:   return to == PS::CLOSED;
        case PS::CLOSED:      return false;
        case PS::ERROR:       return to == PS::CLOSED;
        default:              return false;
    }
}
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_PLUGIN_STATE_HPP */