-
Notifications
You must be signed in to change notification settings - Fork 49
/
ComponentFMUME.h
167 lines (135 loc) · 7.02 KB
/
ComponentFMUME.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*
* This file is part of OpenModelica.
*
* Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
* c/o Linköpings universitet, Department of Computer and Information Science,
* SE-58183 Linköping, Sweden.
*
* All rights reserved.
*
* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
* THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
* ACCORDING TO RECIPIENTS CHOICE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from OSMC, either from the above address,
* from the URLs: http://www.ida.liu.se/projects/OpenModelica or
* http://www.openmodelica.org, and in the OpenModelica distribution.
* GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
*
* This program is distributed WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
* IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
*
* See the full OSMC Public License conditions for more details.
*
*/
#ifndef _OMS_COMPONENT_FMU_ME_H_
#define _OMS_COMPONENT_FMU_ME_H_
#include "Component.h"
#include "ComRef.h"
#include "ResultWriter.h"
#include "Snapshot.h"
#include "Values.h"
#include "Variable.h"
#include <fmilib.h>
#include <map>
#include <pugixml.hpp>
#include <string>
#include <unordered_map>
#include <vector>
namespace oms
{
class ComponentFMUME : public Component
{
public:
~ComponentFMUME();
static Component* NewComponent(const oms::ComRef& cref, System* parentSystem, const std::string& fmuPath, std::string replaceComponent = "");
static Component* NewComponent(const pugi::xml_node& node, System* parentSystem, const std::string& sspVersion, const Snapshot& snapshot);
const FMUInfo* getFMUInfo() const {return &(this->fmuInfo);}
oms_status_enu_t exportToSSD(pugi::xml_node& node, Snapshot& snapshot, std::string variantName) const;
oms_status_enu_t exportToSSV(pugi::xml_node& ssvNode);
void getFilteredUnitDefinitionsToSSD(std::map<std::string, std::map<std::string, std::string>>& unitDefinitions);
oms_status_enu_t exportToSSVTemplate(pugi::xml_node& ssvNode, Snapshot& snapshot);
oms_status_enu_t exportToSSMTemplate(pugi::xml_node& ssmNode);
oms_status_enu_t instantiate();
oms_status_enu_t initialize();
oms_status_enu_t terminate();
oms_status_enu_t reset();
oms_status_enu_t initializeDependencyGraph_initialUnknowns();
oms_status_enu_t initializeDependencyGraph_outputs();
Variable* getVariable(const ComRef& cref);
oms_status_enu_t getBoolean(const ComRef& cref, bool& value);
oms_status_enu_t getBoolean(const fmi2_value_reference_t& vr, bool& value);
oms_status_enu_t getInteger(const ComRef& cref, int& value);
oms_status_enu_t getInteger(const fmi2_value_reference_t& vr, int& value);
oms_status_enu_t getReal(const ComRef& cref, double& value);
oms_status_enu_t getReal(const fmi2_value_reference_t& vr, double& value);
oms_status_enu_t getString(const ComRef& cref, std::string& value);
oms_status_enu_t getString(const fmi2_value_reference_t& vr, std::string& value);
oms_status_enu_t setBoolean(const ComRef& cref, bool value);
oms_status_enu_t setInteger(const ComRef& cref, int value);
oms_status_enu_t setReal(const ComRef& cref, double value);
oms_status_enu_t setString(const ComRef& cref, const std::string& value);
oms_status_enu_t setUnit(const ComRef& cref, const std::string& value);
oms_status_enu_t getDirectionalDerivative(const ComRef& unknownCref, const ComRef& knownCref, double& value);
oms_status_enu_t getDirectionalDerivativeHeper(const int unknownIndex, const int knownIndex, const std::vector<int>& dependencyList, double& value);
oms_status_enu_t deleteStartValue(const ComRef& cref);
oms_status_enu_t updateOrDeleteStartValueInReplacedComponent(std::vector<std::string>& warningList);
oms_status_enu_t setValuesResources(std::vector<Values>& allValuesResources);
std::vector<Values> getValuesResources();
oms_status_enu_t registerSignalsForResultFile(ResultWriter& resultFile);
oms_status_enu_t updateSignals(ResultWriter& resultWriter);
oms_status_enu_t addSignalsToResults(const char* regex);
oms_status_enu_t removeSignalsFromResults(const char* regex);
oms_status_enu_t doEventIteration();
size_t getNumberOfContinuousStates() const {return derivatives.size();}
size_t getNumberOfEventIndicators() const {return nEventIndicators;}
oms_status_enu_t getContinuousStates(double* states);
oms_status_enu_t setContinuousStates(double* states);
oms_status_enu_t getDerivatives(double* derivatives);
oms_status_enu_t getNominalsOfContinuousStates(double* nominals);
oms_status_enu_t getEventindicators(double* eventindicators);
fmi2_import_t* getFMU() {return fmu;}
fmi2_event_info_t* getEventInfo() {return &eventInfo;}
bool getCanGetAndSetState() {return getFMUInfo()->getCanGetAndSetFMUstate();}
oms_status_enu_t setFaultInjection(const ComRef& signal, oms_fault_type_enu_t faultType, double faultValue);
void getFilteredSignals(std::vector<Connector>& filteredSignals) const;
oms_status_enu_t newResources(const std::string& ssvFilename, const std::string& ssmFilename, bool externalResources);
oms_status_enu_t setResourcesHelper1(Values value);
oms_status_enu_t setResourcesHelper2(Values value);
oms_status_enu_t deleteReferencesInSSD(const std::string& filename);
oms_status_enu_t deleteResourcesInSSP(const std::string& filename);
protected:
ComponentFMUME(const ComRef& cref, System* parentSystem, const std::string& fmuPath);
// stop the compiler generating methods copying the object
ComponentFMUME(ComponentFMUME const& copy); ///< not implemented
ComponentFMUME& operator=(ComponentFMUME const& copy); ///< not implemented
oms_status_enu_t renameValues(const ComRef& oldCref, const ComRef& newCref);
void dumpInitialUnknowns();
private:
jm_callbacks callbacks;
fmi2_callback_functions_t callbackFunctions;
fmi_import_context_t* context = NULL;
fmi2_import_t* fmu = NULL;
fmi2_event_info_t eventInfo;
size_t nEventIndicators;
FMUInfo fmuInfo;
std::vector<Variable> allVariables;
std::vector<unsigned int> calculatedParameters;
std::vector<unsigned int> derivatives;
std::vector<unsigned int> inputs;
std::vector<unsigned int> outputs;
std::vector<unsigned int> parameters;
std::vector<bool> exportVariables;
Values values; ///< start values defined before instantiating the FMU and external inputs defined after initialization
std::unordered_map<unsigned int /*result file var ID*/, unsigned int /*allVariables ID*/> resultFileMapping;
std::map<fmi2_value_reference_t, oms_fault_type_t> fib; ///< fault injection blocks
oms::ComRef getValidCref(ComRef cref);
};
}
#endif