TCodeFMU.h

Go to the documentation of this file.

// Copyright (C) 2013-2024 CEA/DES
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 3 of the License, or any
// later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

#ifndef TCODEFMU_H
#define TCODEFMU_H

// ROOT

//URANIE
#include "TCode.h"

// FMI
#ifdef WIN32
#define WIN32_LEAN_AND_MEAN
#include <Windows4Root.h>
#endif
#include "fmilib.h"
#include <JM/jm_portability.h>

#include <string>

namespace URANIE {
namespace Launcher {

class TCodeFMU : public TCode
{
public:

    enum ELogLevel_t {
        log_level_nothing = 0,        
        log_level_fatal,              
        log_level_error,              
        log_level_warning,            
        log_level_info,               
        log_level_verbose,            
        log_level_debug,              
        log_level_all                 
    };

    // Constructors/Destructors
    //  


    TCodeFMU ();
    TCodeFMU(const TString &name, const TString &title);
    TCodeFMU(URANIE::DataServer::TDataServer *tds, TString sFMUfile, Option_t *option ="");

    TCodeFMU(URANIE::Launcher::TCode &mycode);

    virtual ~TCodeFMU ();

    // Static Public attributes
    //  

    // Public attributes
    //  
    //---------------------------------------------
    virtual void init(Option_t *option = "");
    virtual void initRun(forkcode *fjob, Option_t *option = "");

    virtual void start(forkcode *fjob, Option_t *option = "");

    virtual void terminate(Option_t *option = "");

    void initIFirst(Option_t *option = "");



    // Public attribute accessor methods
    //  
    //---------------------------------------------
    void setFMUFile (TString new_var, Option_t *option = "");
    TString getFMUFile () {
        FUNCT_TRACE();
        return _sFMUFile;
    }

    Double_t getStartSimulation() {
        FUNCT_TRACE();
        return _dStart;
    }
    void setStartSimulation(Double_t dval) {
        FUNCT_TRACE();
        _dStart = dval;
        _bStart = kTRUE;
    }
    Double_t getStoptSimulation() {
        FUNCT_TRACE();
        return _dStop;
    }
    void setStopSimulation(Double_t dval) {
        FUNCT_TRACE();
        _dStop = dval;
        _bStop = kTRUE;
    }
    Double_t getStepSimulation() {
        FUNCT_TRACE();
        return _dStep;
    }
    void setStepSimulation(Double_t dval) {
        FUNCT_TRACE();
        _dStep = dval;
        _bStep = kTRUE;
    }

    Double_t getToleranceSimulation() {
        return _dTolerance;
    }
    void setToleranceSimulation(Double_t dval) {
        FUNCT_TRACE();
        _dTolerance = dval;
        _bTolerance = kTRUE;
    }
    void setStartStopSimulation(Double_t dstart, Double_t dstop) {
        FUNCT_TRACE();
        try {
            if ( dstart < dstop ) {
                setStartSimulation(dstart);
                setStopSimulation(dstop);
            } else {
                throw URANIE::Exceptions::UErrorExceptions(
                    __FILE__, __LINE__,
                    Form("TcodeFMU::%s Method\n The start time[%f] is greater than stop  [%e] time", __func__, dstart, dstop));
            }
        } catch (URANIE::Exceptions::UExceptions& ue) {
            ue.printMessage();
            if (ue.getMessageType() > URANIE::Exceptions::UExceptions::kWARNING)
                exit(-1);

        }
    }



    // Public FMI functions
    //
    //---------------------------------------------


    void do_exit(int code)
    {
            printf("Press 'Enter' to exit\n");
            /* getchar(); */
            exit(code);
    }


    // Public attribute accessor methods
    //  

    //---------------------------------------------
    void setLog() {
        _blog = kTRUE;
    }
    void unsetLog() {
        _blog = kFALSE;
    }
    void changeLog() {
        _blog = _blog ? kFALSE : kTRUE;
    }
    Bool_t getLog() {
        return _blog;
    }

    void setLogLevel(ELogLevel_t theLogLevel = log_level_info) {
        _logLevel = theLogLevel;
    }

    ELogLevel_t getLogLevel() {
        return _logLevel;
    }

    virtual void printLog(Option_t *option = "");

protected:

    // Static Protected attributes
    //  

    // Protected attributes
    //  

public:


    // Protected attribute accessor methods
    //  

    //---------------------------------------------
protected:
    TString _sFMUFile;                  
    TString _sFMUWorkingDirectory;      
    ELogLevel_t _logLevel;              
    Double_t _dStart;                   
    Double_t _dStop;                    
    Double_t _dStep;                    
    Double_t _dTolerance;               
    Bool_t   _bStart;                   
    Bool_t   _bStop;                    
    Bool_t   _bStep;                    
    Bool_t   _bTolerance;               
    Bool_t   _binitIFirst;              

    // FMI structures
    fmi_version_enu_t _sVersion;        
    fmi_import_context_t* _context_FMI; 
    fmi1_import_t* _fmi1Import;         
    fmi2_import_t* _fmi2Import;         

    // FMI General informations
    TString _sGenerationTool;            
    TString _sGenerationDateTime;        
    Double_t _dFMUStart;                 
    Double_t _dFMUStop;                  
    Double_t _dFMUStep;                  
    Double_t _dFMUTolerance;             


public:


    // Protected attribute accessor methods
    //  

protected:


private:

    // Static Private attributes
    //  

    // Private attributes
    //  

public:


    // Private attribute accessor methods
    //  

private:
    void treatOption(TString soption);

public:


    // Private attribute accessor methods
    //  

private:

    ClassDef(URANIE::Launcher::TCodeFMU, ID_LAUNCHER)


};

} // End of namespace Launcher
} // End of namespace URANIE

#endif // TCODEFMU_H
// End of File