omModelRunState.h

Go to the documentation of this file.

 
// Copyright (c) 2013-2015 OpenM++
// This code is licensed under the MIT license (see LICENSE.txt for details)
 
#ifndef OM_H_MODEL_RUN_STATE_H
#define OM_H_MODEL_RUN_STATE_H
 
#include <chrono>
#include "common/omHelper.h"   // define IRowBase
 
namespace openm
{
    enum class ExitStatus : int
    {
        OK = 0,
 
        FAIL = 1,
 
        HELPER_ERROR = 4,
 
        MSG_ERROR = 8,
 
        DB_ERROR = 12,
 
        MODEL_ERROR = 16,
 
        SIMULATION_ERROR = 32
    };
 
    enum class ModelStatus : int
    {
        undefined = 0,
 
        init = 1,
 
        progress,
 
        waitProgress,
 
        shutdown,
 
        done = 64,
 
        exit,
 
        error = 128
    };
 
    struct RunStatus
    {
        static const char * init;
 
        static const char * progress;
 
        static const char * waitProgress;
 
        static const char * done;
 
        static const char * exit;
 
        static const char * error;
    };
    
    struct RunState
    {
        ModelStatus theStatus;
 
        int progressCount;
 
        double progressValue;
 
        std::chrono::system_clock::time_point startTime;
 
        std::chrono::system_clock::time_point updateTime;
 
        RunState(void);
 
        bool operator==(const RunState & i_other) const;
 
        static bool isFinal(ModelStatus i_status) { return i_status >= ModelStatus::done; }
 
        static bool isError(ModelStatus i_status) { return i_status >= ModelStatus::error; }
 
        static bool isShutdownOrFinal(ModelStatus i_status) { return i_status == ModelStatus::shutdown || isFinal(i_status); }
 
        static ModelStatus fromRunStatus(const std::string & i_runStatus);
 
        static std::string toRunStatus(ModelStatus i_modelStatus);
 
        ModelStatus setStatus(ModelStatus i_status);
 
        void setProgress(int i_count, double i_value);
    };
 
    struct IModelRunState : public IFinalState
    {
        virtual ~IModelRunState(void) noexcept = 0;
 
        virtual ModelStatus status(void) = 0;
 
        virtual bool isShutdownOrFinal(void) = 0;
 
        virtual RunState get(void) = 0;
 
        virtual ModelStatus updateStatus(ModelStatus i_status) = 0;
 
        virtual void updateProgress(int i_count, double i_value = 0.0) = 0;
    };
 
    struct RunStateItem : public IRowBase
    {
        int runId;
 
        int subId;
 
        RunState state;
 
        RunStateItem(int i_runId, int i_subId, const RunState i_state) : runId(i_runId), subId(i_subId), state(i_state) {}
        RunStateItem(void) : RunStateItem(0, 0, RunState()) {}
    };
}
 
#endif  // OM_H_MODEL_RUN_STATE_H