OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
ComponentFMUCS.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenModelica.
3  *
4  * Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
5  * c/o Linköpings universitet, Department of Computer and Information Science,
6  * SE-58183 Linköping, Sweden.
7  *
8  * All rights reserved.
9  *
10  * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
11  * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
12  * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
13  * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
14  * ACCORDING TO RECIPIENTS CHOICE.
15  *
16  * The OpenModelica software and the Open Source Modelica
17  * Consortium (OSMC) Public License (OSMC-PL) are obtained
18  * from OSMC, either from the above address,
19  * from the URLs: http://www.ida.liu.se/projects/OpenModelica or
20  * http://www.openmodelica.org, and in the OpenModelica distribution.
21  * GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
22  *
23  * This program is distributed WITHOUT ANY WARRANTY; without
24  * even the implied warranty of MERCHANTABILITY or FITNESS
25  * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
26  * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
27  *
28  * See the full OSMC Public License conditions for more details.
29  *
30  */
31 
32 #ifndef _OMS_COMPONENT_FMU_CS_H_
33 #define _OMS_COMPONENT_FMU_CS_H_
34 
35 #include "Component.h"
36 #include "ComRef.h"
37 #include "Option.h"
38 #include "ResultWriter.h"
39 #include "Variable.h"
40 #include <fmilib.h>
41 #include <map>
42 #include <pugixml.hpp>
43 #include <string>
44 #include <unordered_map>
45 #include <vector>
46 
47 namespace oms
48 {
49  class System;
50 
51  class ComponentFMUCS : public Component
52  {
53  public:
55 
56  static Component* NewComponent(const ComRef& cref, System* parentSystem, const std::string& fmuPath);
57  static Component* NewComponent(const pugi::xml_node& node, System* parentSystem);
58  const FMUInfo* getFMUInfo() const {return &(this->fmuInfo);}
59 
60  oms_status_enu_t exportToSSD(pugi::xml_node& node) const;
65 
66  oms_status_enu_t stepUntil(double stopTime);
67 
70 
71  oms_status_enu_t getBoolean(const ComRef& cref, bool& value);
72  oms_status_enu_t getBoolean(const fmi2_value_reference_t& vr, bool& value);
73  oms_status_enu_t getInteger(const ComRef& cref, int& value);
74  oms_status_enu_t getInteger(const fmi2_value_reference_t& vr, int& value);
75  oms_status_enu_t getReal(const ComRef& cref, double& value);
76  oms_status_enu_t getReal(const fmi2_value_reference_t& vr, double& value);
77  oms_status_enu_t setBoolean(const ComRef& cref, bool value);
78  oms_status_enu_t setInteger(const ComRef& cref, int value);
79  oms_status_enu_t setReal(const ComRef& cref, double value);
80 
81  oms_status_enu_t getRealOutputDerivative(const ComRef& cref, double*& value);
82  oms_status_enu_t setRealInputDerivative(const ComRef& cref, double* value, unsigned int order);
83 
86  oms_status_enu_t addSignalsToResults(const char* regex);
87  oms_status_enu_t removeSignalsFromResults(const char* regex);
88 
89  protected:
90  ComponentFMUCS(const ComRef& cref, System* parentSystem, const std::string& fmuPath);
91 
92  // stop the compiler generating methods copying the object
93  ComponentFMUCS(ComponentFMUCS const& copy);
95 
96  private:
97  jm_callbacks callbacks;
98  fmi2_callback_functions_t callbackFunctions;
99  fmi_import_context_t* context = NULL;
100  fmi2_import_t* fmu = NULL;
101  std::string tempDir;
102 
104 
105  std::vector<Variable> allVariables;
106  std::vector<Variable> inputs;
107  std::vector<Variable> outputs;
108  std::vector<Variable> parameters;
109  std::vector<bool> exportVariables;
110 
111  std::map<ComRef, double> realStartValues;
112  std::map<ComRef, int> integerStartValues;
113  std::map<ComRef, bool> booleanStartValues;
114 
115  std::unordered_map<unsigned int /*result file var ID*/, unsigned int /*allVariables ID*/> resultFileMapping;
116 
117  double time;
118  };
119 }
120 
121 #endif
oms_status_enu_t setReal(const ComRef &cref, double value)
Definition: ComponentFMUCS.cpp:762
oms_status_enu_t setRealInputDerivative(const ComRef &cref, double *value, unsigned int order)
Definition: ComponentFMUCS.cpp:679
FMU info.
Definition: FMUInfo.h:45
Definition: ComponentFMUCS.h:51
Definition: ResultWriter.h:67
oms_status_enu_t addSignalsToResults(const char *regex)
Definition: ComponentFMUCS.cpp:897
oms_status_enu_t getReal(const ComRef &cref, double &value)
Definition: ComponentFMUCS.cpp:627
jm_callbacks callbacks
Definition: ComponentFMUCS.h:97
oms_status_enu_t exportToSSD(pugi::xml_node &node) const
Definition: ComponentFMUCS.cpp:298
oms_status_enu_t initialize()
Definition: ComponentFMUCS.cpp:463
oms_status_enu_t getBoolean(const ComRef &cref, bool &value)
Definition: ComponentFMUCS.cpp:562
System * parentSystem
Definition: Component.h:126
std::map< ComRef, double > realStartValues
parameters and start values defined before instantiating the FMU
Definition: ComponentFMUCS.h:111
oms_status_enu_t reset()
Definition: ComponentFMUCS.cpp:488
oms_status_enu_t setBoolean(const ComRef &cref, bool value)
Definition: ComponentFMUCS.cpp:705
oms_status_enu_t instantiate()
Definition: ComponentFMUCS.cpp:416
oms_status_enu_t updateSignals(ResultWriter &resultWriter)
Definition: ComponentFMUCS.cpp:857
ComponentFMUCS & operator=(ComponentFMUCS const &copy)
not implemented
oms_status_enu_t
Definition: Types.h:43
ComponentFMUCS(const ComRef &cref, System *parentSystem, const std::string &fmuPath)
Definition: ComponentFMUCS.cpp:46
static Component * NewComponent(const ComRef &cref, System *parentSystem, const std::string &fmuPath)
Definition: ComponentFMUCS.cpp:65
oms_status_enu_t registerSignalsForResultFile(ResultWriter &resultFile)
Definition: ComponentFMUCS.cpp:794
std::vector< Variable > allVariables
Definition: ComponentFMUCS.h:105
oms_status_enu_t getRealOutputDerivative(const ComRef &cref, double *&value)
Definition: ComponentFMUCS.cpp:647
std::vector< Variable > parameters
Definition: ComponentFMUCS.h:108
oms_status_enu_t initializeDependencyGraph_initialUnknowns()
Definition: ComponentFMUCS.cpp:327
fmi_import_context_t * context
Definition: ComponentFMUCS.h:99
std::vector< Variable > inputs
Definition: ComponentFMUCS.h:106
ComRef - component reference.
Definition: ComRef.h:43
oms_status_enu_t getInteger(const ComRef &cref, int &value)
Definition: ComponentFMUCS.cpp:592
Definition: Component.h:54
~ComponentFMUCS()
Definition: ComponentFMUCS.cpp:51
fmi2_import_t * fmu
Definition: ComponentFMUCS.h:100
oms_status_enu_t setInteger(const ComRef &cref, int value)
Definition: ComponentFMUCS.cpp:734
Definition: BusConnector.h:15
oms_status_enu_t stepUntil(double stopTime)
Definition: ComponentFMUCS.cpp:507
fmi2_callback_functions_t callbackFunctions
Definition: ComponentFMUCS.h:98
ComRef cref
Definition: Component.h:127
oms_status_enu_t removeSignalsFromResults(const char *regex)
Definition: ComponentFMUCS.cpp:916
std::map< ComRef, bool > booleanStartValues
parameters and start values defined before instantiating the FMU
Definition: ComponentFMUCS.h:113
oms_status_enu_t initializeDependencyGraph_outputs()
Definition: ComponentFMUCS.cpp:372
std::vector< bool > exportVariables
Definition: ComponentFMUCS.h:109
std::unordered_map< unsigned int, unsigned int > resultFileMapping
Definition: ComponentFMUCS.h:115
std::vector< Variable > outputs
Definition: ComponentFMUCS.h:107
std::string tempDir
Definition: ComponentFMUCS.h:101
double time
Definition: ComponentFMUCS.h:117
Definition: System.h:58
oms_status_enu_t terminate()
Definition: ComponentFMUCS.cpp:477
std::map< ComRef, int > integerStartValues
parameters and start values defined before instantiating the FMU
Definition: ComponentFMUCS.h:112
const FMUInfo * getFMUInfo() const
Definition: ComponentFMUCS.h:58
FMUInfo fmuInfo
Definition: ComponentFMUCS.h:103