Model.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX INC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX INC.
******************************************************************************/
/*
Model header file - Includes declaration for model class which is the simulation base unit
 
Author: Alex Reynolds
*/
#ifndef SIMULATION_MODEL_H
#define SIMULATION_MODEL_H
 
#include "nlohmann/json.hpp"
 
#include "flight/App.h"
#include "SimulationSteps.h"
#include "SimulationExecutive.h"
 
// --------------------------------------------------------------------------
// Model naming macro
// --------------------------------------------------------------------------
// This macro works only inside models, and is used to generate a model class
// name. It exists more or less to prevent duplication of model naming efforts
// by creating the model class name, associated constructors, and setting the
// internal name of the model
#define MODEL(MODEL_NAME) \
class MODEL_NAME : public Model {\
public:\
    MODEL_NAME(Model &pnt, const std::string &m_name=#MODEL_NAME);\
    MODEL_NAME(SimulationExecutive &e, const std::string &m_name=#MODEL_NAME);\
    MODEL_NAME(Model &pnt, int schedule_slot, const std::string &m_name=#MODEL_NAME);\
    MODEL_NAME(SimulationExecutive &e, int schedule_slot, const std::string &m_name=#MODEL_NAME);\
    virtual ~MODEL_NAME();\
protected:\
    virtual std::string classType() {return #MODEL_NAME;}
 

#define MODEL_LOG(LEVEL, MESSAGE)\
    if((uint8)LEVEL) {\
        std::string log_msg = MESSAGE;\
        LOG(LEVEL, log_msg.c_str());\
    }
 
namespace warptwin {
    class SimulationExecutive;

    class Model : public warpos::App {
    public:
        Model(Model &pnt, int16 schedule_slot, const std::string &m_name="Unnamed");

        Model(SimulationExecutive &executive, int16 schedule_slot, const std::string &m_name="Unnamed");

        virtual ~Model() {};

        std::vector<std::string> listDefaultConfigs();

        int configureFromDefault(const std::string &default_name);

        int configureFromJson(const std::string &file_path);

        int configureFromJson(nlohmann::json j);

        virtual nlohmann::json asJson();

        void dump();
    protected:
        SimulationExecutive& exc;

        virtual std::string classType() {return "Model";}

        std::string _default_configuration_name = "";

        int16 _schedule_slot = 0;
    };
}
 
#endif