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 "ResultWriter.h"
38 #include "Snapshot.h"
39 #include "Values.h"
40 #include "Variable.h"
41 
42 #include <fmilib.h>
43 #include <map>
44 #include <pugixml.hpp>
45 #include <string>
46 #include <unordered_map>
47 #include <vector>
48 #include <cmath>
49 
50 namespace oms
51 {
52  class System;
53 
54  class ComponentFMUCS : public Component
55  {
56  public:
58 
59  static Component* NewComponent(const ComRef& cref, System* parentSystem, const std::string& fmuPath, std::string replaceComponent = "");
60  static Component* NewComponent(const pugi::xml_node& node, System* parentSystem, const std::string& sspVersion, const Snapshot& snapshot, std::string variantName);
61  const FMUInfo* getFMUInfo() const {return &(this->fmuInfo);}
62 
63  oms_status_enu_t exportToSSD(pugi::xml_node& node, Snapshot& snapshot, std::string variantName) const;
64  oms_status_enu_t exportToSSV(pugi::xml_node& ssvNode);
65  void getFilteredUnitDefinitionsToSSD(std::map<std::string, std::map<std::string, std::string>>& unitDefinitions);
66  oms_status_enu_t exportToSSVTemplate(pugi::xml_node& ssvNode, Snapshot& snapshot);
67  oms_status_enu_t exportToSSMTemplate(pugi::xml_node& ssmNode);
72 
73  oms_status_enu_t stepUntil(double stopTime);
74 
77 
78  Variable* getVariable(const ComRef& cref);
79 
80  oms_status_enu_t getBoolean(const ComRef& cref, bool& value);
81  oms_status_enu_t getBoolean(const fmi2_value_reference_t& vr, bool& value);
82  oms_status_enu_t getInteger(const ComRef& cref, int& value);
83  oms_status_enu_t getInteger(const fmi2_value_reference_t& vr, int& value);
84  oms_status_enu_t getReal(const ComRef& cref, double& value);
85  oms_status_enu_t getReal(const fmi2_value_reference_t& vr, double& value);
86  oms_status_enu_t getString(const ComRef& cref, std::string& value);
87  oms_status_enu_t getString(const fmi2_value_reference_t& vr, std::string& value);
88  oms_status_enu_t setBoolean(const ComRef& cref, bool value);
89  oms_status_enu_t setInteger(const ComRef& cref, int value);
90  oms_status_enu_t setReal(const ComRef& cref, double value);
91  oms_status_enu_t setString(const ComRef& cref, const std::string& value);
92  oms_status_enu_t setUnit(const ComRef& cref, const std::string& value);
93 
94  oms_status_enu_t getDirectionalDerivative(const ComRef& unknownCref, const ComRef& knownCref, double& value);
95  oms_status_enu_t getDirectionalDerivativeHeper(const int unknownIndex, const int knownindex, const std::vector<int>& dependencyList, double& value);
96 
98  oms_status_enu_t updateOrDeleteStartValueInReplacedComponent(std::vector<std::string>& warningList);
99  oms_status_enu_t setValuesResources(std::vector<Values>& allValuesResources);
100  std::vector<Values> getValuesResources();
101 
102  oms_status_enu_t setFmuTime(double time) {this->time = time; return oms_status_ok;}
103  fmi2_import_t* getFMU() {return fmu;}
104  std::vector<Variable> getAllVariables() {return allVariables;}
105 
108 
111  oms_status_enu_t addSignalsToResults(const char* regex);
112  oms_status_enu_t removeSignalsFromResults(const char* regex);
113 
118 
119  oms_status_enu_t setFaultInjection(const ComRef& signal, oms_fault_type_enu_t faultType, double faultValue);
120 
121  void getFilteredSignals(std::vector<Connector>& filteredSignals) const;
122 
123  oms_status_enu_t newResources(const std::string& ssvFilename, const std::string& ssmFilename, bool externalResources);
126 
127  oms_status_enu_t deleteReferencesInSSD(const std::string& filename);
128  oms_status_enu_t deleteResourcesInSSP(const std::string& filename);
129  void copyModelDescriptionUnit(Values& value);
130 
131  protected:
132  ComponentFMUCS(const ComRef& cref, System* parentSystem, const std::string& fmuPath);
133 
134  // stop the compiler generating methods copying the object
135  ComponentFMUCS(ComponentFMUCS const& copy);
136  ComponentFMUCS& operator=(ComponentFMUCS const& copy);
137 
138  oms_status_enu_t renameValues(const ComRef& oldCref, const ComRef& newCref);
139 
140  void dumpInitialUnknowns();
141 
142  private:
143  jm_callbacks callbacks;
144  fmi2_callback_functions_t callbackFunctions;
145  fmi_import_context_t* context = NULL;
146  fmi2_import_t* fmu = NULL;
147 
149 
150  std::vector<Variable> allVariables;
151  std::vector<unsigned int> calculatedParameters;
152  std::vector<unsigned int> derivatives;
153  std::vector<unsigned int> inputs;
154  std::vector<unsigned int> outputs;
155  std::vector<unsigned int> parameters;
156  std::vector<bool> exportVariables;
157 
159 
160  std::unordered_map<unsigned int /*result file var ID*/, unsigned int /*allVariables ID*/> resultFileMapping;
161 
162  double time;
163 
164  fmi2_FMU_state_t fmuState = NULL;
165  double fmuStateTime;
166 
167  std::map<fmi2_value_reference_t, oms_fault_type_t> fib;
169  };
170 }
171 
172 #endif
oms_status_enu_t setString(const ComRef &cref, const std::string &value)
Definition: ComponentFMUCS.cpp:1665
oms_status_enu_t saveState()
Definition: ComponentFMUCS.cpp:1964
oms_status_enu_t setReal(const ComRef &cref, double value)
Definition: ComponentFMUCS.cpp:1607
std::vector< unsigned int > calculatedParameters
Definition: ComponentFMUCS.h:151
oms_status_enu_t exportToSSV(pugi::xml_node &ssvNode)
Definition: ComponentFMUCS.cpp:424
FMU info.
Definition: FMUInfo.h:45
std::vector< unsigned int > parameters
Definition: ComponentFMUCS.h:155
Definition: ComponentFMUCS.h:54
Definition: Types.h:44
oms_status_enu_t setFaultInjection(const ComRef &signal, oms_fault_type_enu_t faultType, double faultValue)
Definition: ComponentFMUCS.cpp:1994
Definition: ResultWriter.h:68
oms_status_enu_t setResourcesHelper2(Values value)
Definition: ComponentFMUCS.cpp:721
oms_status_enu_t restoreState()
Definition: ComponentFMUCS.cpp:1985
oms_status_enu_t addSignalsToResults(const char *regex)
Definition: ComponentFMUCS.cpp:1926
oms_status_enu_t getReal(const ComRef &cref, double &value)
Definition: ComponentFMUCS.cpp:1166
jm_callbacks callbacks
Definition: ComponentFMUCS.h:143
static Component * NewComponent(const ComRef &cref, System *parentSystem, const std::string &fmuPath, std::string replaceComponent="")
Definition: ComponentFMUCS.cpp:63
oms_status_enu_t initialize()
Definition: ComponentFMUCS.cpp:846
void dumpInitialUnknowns()
Definition: ComponentFMUCS.cpp:442
oms_status_enu_t getBoolean(const ComRef &cref, bool &value)
Definition: ComponentFMUCS.cpp:947
oms_status_enu_t setRealInputDerivative(const ComRef &cref, const SignalDerivative &der)
Definition: ComponentFMUCS.cpp:1476
System * parentSystem
Definition: Component.h:164
oms_status_enu_t newResources(const std::string &ssvFilename, const std::string &ssmFilename, bool externalResources)
Definition: ComponentFMUCS.cpp:788
oms_status_enu_t reset()
Definition: ComponentFMUCS.cpp:873
Definition: Variable.h:45
oms_status_enu_t setBoolean(const ComRef &cref, bool value)
Definition: ComponentFMUCS.cpp:1505
oms_status_enu_t instantiate()
Definition: ComponentFMUCS.cpp:642
void getFilteredUnitDefinitionsToSSD(std::map< std::string, std::map< std::string, std::string >> &unitDefinitions)
Definition: ComponentFMUCS.cpp:402
oms_status_enu_t updateSignals(ResultWriter &resultWriter)
Definition: ComponentFMUCS.cpp:1886
oms_status_enu_t deleteStartValue(const ComRef &cref)
Definition: ComponentFMUCS.cpp:1761
std::map< fmi2_value_reference_t, oms_fault_type_t > fib
fault injection blocks
Definition: ComponentFMUCS.h:167
ComponentFMUCS & operator=(ComponentFMUCS const &copy)
not implemented
oms_status_enu_t getRealOutputDerivative(const ComRef &cref, SignalDerivative &der)
Definition: ComponentFMUCS.cpp:1455
oms_status_enu_t getString(const ComRef &cref, std::string &value)
Definition: ComponentFMUCS.cpp:1258
oms_status_enu_t setFmuTime(double time)
Definition: ComponentFMUCS.h:102
fmi2_import_t * getFMU()
Definition: ComponentFMUCS.h:103
oms_status_enu_t exportToSSVTemplate(pugi::xml_node &ssvNode, Snapshot &snapshot)
Definition: ComponentFMUCS.cpp:429
oms_status_enu_t
Definition: Types.h:43
double fmuStateTime
Definition: ComponentFMUCS.h:165
ComponentFMUCS(const ComRef &cref, System *parentSystem, const std::string &fmuPath)
Definition: ComponentFMUCS.cpp:50
std::vector< Variable > getAllVariables()
Definition: ComponentFMUCS.h:104
oms_status_enu_t exportToSSMTemplate(pugi::xml_node &ssmNode)
Definition: ComponentFMUCS.cpp:436
Definition: Snapshot.h:46
oms_status_enu_t registerSignalsForResultFile(ResultWriter &resultFile)
Definition: ComponentFMUCS.cpp:1823
void copyModelDescriptionUnit(Values &value)
std::vector< Variable > allVariables
Definition: ComponentFMUCS.h:150
bool getCanGetAndSetState()
Definition: ComponentFMUCS.h:114
oms_status_enu_t freeState()
Definition: ComponentFMUCS.cpp:1973
std::vector< unsigned int > inputs
Definition: ComponentFMUCS.h:153
oms_status_enu_t initializeDependencyGraph_initialUnknowns()
Definition: ComponentFMUCS.cpp:459
fmi_import_context_t * context
Definition: ComponentFMUCS.h:145
oms_status_enu_t deleteReferencesInSSD(const std::string &filename)
Definition: ComponentFMUCS.cpp:830
ComRef - component reference.
Definition: ComRef.h:46
oms_status_enu_t setValuesResources(std::vector< Values > &allValuesResources)
Definition: ComponentFMUCS.cpp:1786
oms_status_enu_t getInteger(const ComRef &cref, int &value)
Definition: ComponentFMUCS.cpp:1037
std::vector< unsigned int > outputs
Definition: ComponentFMUCS.h:154
Definition: Component.h:60
oms_status_enu_t setUnit(const ComRef &cref, const std::string &value)
Definition: ComponentFMUCS.cpp:1720
~ComponentFMUCS()
Definition: ComponentFMUCS.cpp:55
oms_status_enu_t setResourcesHelper1(Values value)
Definition: ComponentFMUCS.cpp:697
fmi2_import_t * fmu
Definition: ComponentFMUCS.h:146
Definition: Values.h:45
oms_status_enu_t deleteResourcesInSSP(const std::string &filename)
Definition: ComponentFMUCS.cpp:838
oms_status_enu_t setInteger(const ComRef &cref, int value)
Definition: ComponentFMUCS.cpp:1556
Definition: AlgLoop.h:44
std::vector< Values > getValuesResources()
Definition: ComponentFMUCS.cpp:1792
oms_fault_type_enu_t
Definition: Types.h:76
oms::ComRef getValidCref(ComRef cref)
Definition: ComponentFMUCS.cpp:778
oms_status_enu_t stepUntil(double stopTime)
Definition: ComponentFMUCS.cpp:892
oms_status_enu_t exportToSSD(pugi::xml_node &node, Snapshot &snapshot, std::string variantName) const
Definition: ComponentFMUCS.cpp:369
fmi2_callback_functions_t callbackFunctions
Definition: ComponentFMUCS.h:144
ComRef cref
Definition: Component.h:165
oms_status_enu_t renameValues(const ComRef &oldCref, const ComRef &newCref)
Definition: ComponentFMUCS.cpp:2026
oms_status_enu_t removeSignalsFromResults(const char *regex)
Definition: ComponentFMUCS.cpp:1945
const char * signal
Definition: Tags.cpp:38
oms_status_enu_t initializeDependencyGraph_outputs()
Definition: ComponentFMUCS.cpp:592
std::vector< bool > exportVariables
Definition: ComponentFMUCS.h:156
bool getCanGetAndSetFMUstate() const
Definition: FMUInfo.h:57
std::unordered_map< unsigned int, unsigned int > resultFileMapping
Definition: ComponentFMUCS.h:160
fmi2_FMU_state_t fmuState
Definition: ComponentFMUCS.h:164
double time
Definition: ComponentFMUCS.h:162
Definition: System.h:69
Variable * getVariable(const ComRef &cref)
Definition: ComponentFMUCS.cpp:1117
Values values
start values defined before instantiating the FMU and external inputs defined after initialization ...
Definition: ComponentFMUCS.h:158
oms_status_enu_t terminate()
Definition: ComponentFMUCS.cpp:860
oms_status_enu_t getDirectionalDerivative(const ComRef &unknownCref, const ComRef &knownCref, double &value)
Definition: ComponentFMUCS.cpp:1338
const FMUInfo * getFMUInfo() const
Definition: ComponentFMUCS.h:61
void getFilteredSignals(std::vector< Connector > &filteredSignals) const
Definition: ComponentFMUCS.cpp:2017
std::vector< unsigned int > derivatives
Definition: ComponentFMUCS.h:152
FMUInfo fmuInfo
Definition: ComponentFMUCS.h:148
oms_status_enu_t updateOrDeleteStartValueInReplacedComponent(std::vector< std::string > &warningList)
Definition: ComponentFMUCS.cpp:1797
Definition: SignalDerivative.h:41
oms_status_enu_t getDirectionalDerivativeHeper(const int unknownIndex, const int knownindex, const std::vector< int > &dependencyList, double &value)
Definition: ComponentFMUCS.cpp:1427