model.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 MODEL_H
#define MODEL_H
 
#include <memory>
#include <stdexcept>
#include <mutex>
#include <future>
#include <list>
using namespace std;
 
#include "libopenm/omLog.h"
#include "libopenm/common/omFile.h"
#include "libopenm/omModel.h"
#include "libopenm/common/xz_crc64.h"
#include "libopenm/db/dbMetaRow.h"
#include "dbMetaTable.h"
#include "modelRunState.h"
#include "metaHolder.h"
#include "runController.h"
 
namespace openm
{
    class ModelBase : public IModel
    {
    public:
        ~ModelBase(void) noexcept { }
 
        static ModelBase * create(
            int i_runId,
            int i_subCount,
            int i_subId,
            RunController * i_runCtrl,
            const MetaHolder * i_metaStore 
            );
 
        int subValueCount(void) const noexcept override { return runOptions()->subValueCount; }
        
        int subValueId(void) const noexcept override { return runOptions()->subValueId; }
 
        int parameterSubValueIndex(const char * i_name) const override;
 
        const RunOptions * runOptions(void) const override { return &runOpts; }
 
        int tableIdByName(const char * i_name) const override { return runCtrl->tableIdByName(i_name); };
 
        bool isSuppressed(const char * i_name) const override { return runCtrl->isSuppressed(i_name); };
 
        void writeOutputTable(const char * i_name, size_t i_size, forward_list<unique_ptr<double[]> > & io_accValues) override;
 
        void updateProgress(int i_count, double i_value = 0.0) override { runCtrl->runStateStore().updateProgress(runId, runOpts.subValueId, i_count, i_value); }
 
        virtual void writeDbMicrodata(int i_entityKind, uint64_t i_microdataKey, const void * i_entityThis) override;
 
        virtual void writeCsvMicrodata(int i_entityKind, uint64_t i_microdataKey, int i_eventId, bool i_isSameEntity, const void * i_entityThis) override;
 
    private:
        int modelId;                    // model id in database
        int runId;                      // model run id
        RunController * runCtrl;        // run controller interface
        const MetaHolder * metaStore;   // metadata tables
        RunOptions runOpts;             // model run options
        string microdataBuf;            // microdata write buffer
 
        ModelBase(
            int i_modelId,
            int i_runId,
            int i_subCount,
            int i_subId,
            RunController * i_runCtrl,
            const MetaHolder * i_metaStore
            );
 
        // helper struct to store output table save status
        struct TableDoneItem
        {
            int tableId;    // output table id
            bool isDone;    // if true then table is written into db or send to root process
 
            TableDoneItem(const TableDicRow & i_tableRow) : tableId(i_tableRow.tableId), isDone(false)
            { }
        };
        vector<TableDoneItem> tableDoneVec;     // status for all output tables of sub-value
 
    private:
        ModelBase(const ModelBase & i_model) = delete;
        ModelBase & operator=(const ModelBase & i_model) = delete;
    };
}
 
#endif  // MODEL_H