OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
Component.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_H_
33 #define _OMS_COMPONENT_H_
34 
35 #include "Clock.h"
36 #include "ComRef.h"
37 #include "Connector.h"
38 #include "DirectedGraph.h"
39 #include "Element.h"
40 #include "FMUInfo.h"
41 #include "Logging.h"
42 #include "ResultWriter.h"
43 #include "SignalDerivative.h"
44 #include "Snapshot.h"
45 #include "OMSimulator/Types.h"
46 #include "Values.h"
47 
48 #include <fmi4c.h>
49 #include <pugixml.hpp>
50 
51 namespace oms
52 {
53  class System;
54  class Model;
55  class Variable;
56 
57  void fmi2logger(fmi2ComponentEnvironment env, fmi2String instanceName, fmi2Status status, fmi2String category, fmi2String message, ...);
58 
59  class Component
60  {
61  public:
62  virtual ~Component();
63 
64  virtual oms_status_enu_t addSignalsToResults(const char* regex) = 0;
65  virtual oms_status_enu_t exportToSSD(pugi::xml_node& node, Snapshot& snapshot, std::string variantName) const = 0;
66  virtual oms_status_enu_t exportToSSV(pugi::xml_node& ssvNode) { return logError_NotImplemented; }
67  virtual void getFilteredUnitDefinitionsToSSD(std::map<std::string, std::map<std::string, std::string>>& unitDefinitions) { return ; }
68  virtual void getFilteredEnumerationDefinitionsToSSD(std::map<std::string, std::map<std::string, std::string>>& enumerationDefinitions) { return ; }
69 
70  virtual oms_status_enu_t initialize() = 0;
71  virtual oms_status_enu_t instantiate() = 0;
72  virtual oms_status_enu_t registerSignalsForResultFile(ResultWriter& resultFile) = 0;
73  virtual oms_status_enu_t removeSignalsFromResults(const char* regex) = 0;
74  virtual oms_status_enu_t reset() = 0;
75  virtual oms_status_enu_t terminate() = 0;
76  virtual oms_status_enu_t updateSignals(ResultWriter& resultWriter) = 0;
77  virtual Variable* getVariable(const ComRef& cref) = 0;
78 
79  virtual bool getCanGetAndSetState() { return false; }
80  virtual const FMUInfo* getFMUInfo() const { return nullptr; }
81  virtual oms_status_enu_t deleteStartValue(const ComRef& cref) { return oms_status_ok; }
82  virtual std::vector<Values> getValuesResources() { return{}; }
83  virtual Values& getValues() {return values;}
84  virtual oms_status_enu_t setValuesResources(Values& values) { return oms_status_ok; }
85  virtual oms_status_enu_t updateOrDeleteStartValueInReplacedComponent(std::vector<std::string> &warningList) { return oms_status_ok; }
86  virtual oms_status_enu_t exportToSSMTemplate(pugi::xml_node& ssmNode) { return logError_NotImplemented; }
87  virtual oms_status_enu_t exportToSSVTemplate(pugi::xml_node& ssvNode, Snapshot& snapshot) { return logError_NotImplemented; }
88  virtual oms_status_enu_t freeState() { return logError_NotImplemented; }
89  virtual oms_status_enu_t getBoolean(const ComRef& cref, bool& value) { return logError_NotImplemented; }
90  virtual oms_status_enu_t getInteger(const ComRef& cref, int& value) { return logError_NotImplemented; }
91  virtual oms_status_enu_t getReal(const ComRef& cref, double& value) { return logError_NotImplemented; }
92  virtual oms_status_enu_t getString(const ComRef& cref, std::string& value) { return logError_NotImplemented; }
93  virtual oms_status_enu_t getRealOutputDerivative(const ComRef& cref, SignalDerivative& der) { return logError_NotImplemented; }
94  virtual oms_status_enu_t getDirectionalDerivative(const ComRef& unknownCref, const ComRef& knownCref, double& value) { return logError_NotImplemented; }
95  virtual oms_status_enu_t restoreState() { return logError_NotImplemented; }
96  virtual oms_status_enu_t saveState() { return logError_NotImplemented; }
97  virtual oms_status_enu_t setBoolean(const ComRef& cref, bool value) { return logError_NotImplemented; }
98  virtual oms_status_enu_t setFaultInjection(const ComRef& signal, oms_fault_type_enu_t faultType, double faultValue) { return oms_status_error; }
99  virtual oms_status_enu_t setInteger(const ComRef& cref, int value) { return logError_NotImplemented; }
100  virtual oms_status_enu_t setReal(const ComRef& cref, double value) { return logError_NotImplemented; }
101  virtual oms_status_enu_t setString(const ComRef& cref, const std::string& value) { return logError_NotImplemented; }
102  virtual oms_status_enu_t setUnit(const ComRef& cref, const std::string& value) { return logError_NotImplemented; }
103  virtual oms_status_enu_t setRealInputDerivative(const ComRef& cref, const SignalDerivative& der) { return logError_NotImplemented; }
104  virtual oms_status_enu_t stepUntil(double stopTime) { return oms_status_ok; }
105  virtual oms_status_enu_t newResources(const std::string& ssvFileName, const std::string& ssmFileName, bool externalResources) { return logError_NotImplemented; }
106  virtual oms_status_enu_t addResources(std::string& filename) { return logError_NotImplemented; }
107  virtual oms_status_enu_t deleteReferencesInSSD(const std::string& filename) {return logError_NotImplemented;}
108  virtual oms_status_enu_t deleteResourcesInSSP(const std::string& filename) {return logError_NotImplemented;}
109 
110  const ComRef& getCref() const { return cref; }
111  ComRef getFullCref() const;
112  Element* getElement() { return &element; }
114  Connector** getConnectors() { return &connectors[0]; }
115  oms_status_enu_t deleteConnector(const ComRef& cref);
116  void getAllResources(std::vector<std::string>& resources) const { resources.push_back(path); }
117  const std::string& getPath() const { return path; }
118  const std::string& getTempDir() const { return tempDir; }
119  void setPath(const std::string& newPath) { this->path = newPath; }
120  void setTempDir(const std::string& tempDir) { this->tempDir = tempDir; }
121  oms_component_enu_t getType() const { return type; }
122  void fetchAllVars(bool enableOption) { fetchAllVars_ = enableOption; }
123  System* getParentSystem() const { return parentSystem; }
124  Model& getModel() const;
125  void setGeometry(const ssd::ElementGeometry& geometry) { element.setGeometry(&geometry); }
126 
127  oms_status_enu_t addTLMBus(const oms::ComRef& cref, oms_tlm_domain_t domain, const int dimensions, const oms_tlm_interpolation_t interpolation);
128 #if !defined(NO_TLM)
131 #endif
132  oms_status_enu_t addConnectorToTLMBus(const ComRef& busCref, const ComRef& connectorCref, const std::string type);
133  oms_status_enu_t deleteConnectorFromTLMBus(const ComRef& busCref, const ComRef& connectorCref);
134 
137 
138  oms_status_enu_t rename(const ComRef& newCref);
139 
140  virtual void getFilteredSignals(std::vector<Connector>& filteredSignals) const = 0;
141 
142  protected:
143  Component(const ComRef& cref, oms_component_enu_t type, System* parentSystem, const std::string& path);
144 
145  // stop the compiler generating methods copying the object
146  Component(Component const&);
147  Component& operator=(Component const&);
148 
149  virtual oms_status_enu_t renameValues(const ComRef& oldCref, const ComRef& newCref) { return oms_status_ok; }
150 
151  protected:
155  std::vector<Connector*> connectors;
156 #if !defined(NO_TLM)
157  std::vector<TLMBusConnector*> tlmbusconnectors;
158 #endif
159 
161  unsigned int clock_id;
162  bool fetchAllVars_ = false;
163 
164  private:
167  oms_component_enu_t type;
168  std::string path;
169  std::string tempDir;
171  };
172 }
173 
174 #endif
oms::Component::addConnectorToTLMBus
oms_status_enu_t addConnectorToTLMBus(const ComRef &busCref, const ComRef &connectorCref, const std::string type)
Definition: Component.cpp:137
oms
Definition: AlgLoop.h:44
System.h
oms::Component::getElement
Element * getElement()
Definition: Component.h:112
Clock
Definition: Clock.h:38
oms::Component::cref
ComRef cref
Definition: Component.h:166
logDebugEnabled
#define logDebugEnabled()
Definition: Logging.h:106
oms::Component::getFilteredUnitDefinitionsToSSD
virtual void getFilteredUnitDefinitionsToSSD(std::map< std::string, std::map< std::string, std::string >> &unitDefinitions)
Definition: Component.h:67
oms::SignalDerivative
Definition: SignalDerivative.h:41
ComRef.h
oms::Component::getRealOutputDerivative
virtual oms_status_enu_t getRealOutputDerivative(const ComRef &cref, SignalDerivative &der)
Definition: Component.h:93
oms::Model
Definition: Model.h:52
oms::Component::getFullCref
ComRef getFullCref() const
Definition: Component.cpp:100
oms::Component::setBoolean
virtual oms_status_enu_t setBoolean(const ComRef &cref, bool value)
Definition: Component.h:97
Model.h
logError_BusNotInComponent
#define logError_BusNotInComponent(cref, component)
Definition: Logging.h:123
oms::ComRef
ComRef - component reference.
Definition: ComRef.h:46
oms::Component::exportToSSD
virtual oms_status_enu_t exportToSSD(pugi::xml_node &node, Snapshot &snapshot, std::string variantName) const =0
oms::Component::newResources
virtual oms_status_enu_t newResources(const std::string &ssvFileName, const std::string &ssmFileName, bool externalResources)
Definition: Component.h:105
oms::ssp::Draft20180219::ssd::component
const char * component
Definition: Tags.cpp:45
oms::Component::rename
oms_status_enu_t rename(const ComRef &newCref)
rename submodules, e.g., fmu:s
Definition: Component.cpp:205
oms::Component::parentSystem
System * parentSystem
Definition: Component.h:165
oms::Component::tlmbusconnectors
std::vector< TLMBusConnector * > tlmbusconnectors
Definition: Component.h:157
logError_NotImplemented
#define logError_NotImplemented
Definition: Logging.h:141
oms::Component::getDirectionalDerivative
virtual oms_status_enu_t getDirectionalDerivative(const ComRef &unknownCref, const ComRef &knownCref, double &value)
Definition: Component.h:94
oms::Component::addSignalsToResults
virtual oms_status_enu_t addSignalsToResults(const char *regex)=0
logError_ConnectorNotInComponent
#define logError_ConnectorNotInComponent(cref, component)
Definition: Logging.h:128
oms::Component::getFilteredSignals
virtual void getFilteredSignals(std::vector< Connector > &filteredSignals) const =0
oms::Component::connectors
std::vector< Connector * > connectors
Definition: Component.h:155
oms::Component::fetchAllVars_
bool fetchAllVars_
Definition: Component.h:162
oms::Component::setInteger
virtual oms_status_enu_t setInteger(const ComRef &cref, int value)
Definition: Component.h:99
Snapshot.h
oms::Component::getConnector
Connector * getConnector(const ComRef &cref)
Definition: Component.cpp:175
oms::Component::fetchAllVars
void fetchAllVars(bool enableOption)
Definition: Component.h:122
oms::Component::setUnit
virtual oms_status_enu_t setUnit(const ComRef &cref, const std::string &value)
Definition: Component.h:102
oms::Component::setReal
virtual oms_status_enu_t setReal(const ComRef &cref, double value)
Definition: Component.h:100
oms::Component::outputsGraph
DirectedGraph outputsGraph
Definition: Component.h:153
oms::ComRef::isValidIdent
static bool isValidIdent(const std::string &ident)
Definition: ComRef.cpp:89
oms::Component::getValues
virtual Values & getValues()
Definition: Component.h:83
DirectedGraph.h
oms::Component::getString
virtual oms_status_enu_t getString(const ComRef &cref, std::string &value)
Definition: Component.h:92
oms::Component::addTLMBus
oms_status_enu_t addTLMBus(const oms::ComRef &cref, oms_tlm_domain_t domain, const int dimensions, const oms_tlm_interpolation_t interpolation)
Definition: Component.cpp:110
oms::Element
Element.
Definition: Element.h:49
oms::Component::getVariable
virtual Variable * getVariable(const ComRef &cref)=0
oms::Component::addResources
virtual oms_status_enu_t addResources(std::string &filename)
Definition: Component.h:106
oms::Component::registerSignalsForResultFile
virtual oms_status_enu_t registerSignalsForResultFile(ResultWriter &resultFile)=0
oms::FMUInfo
FMU info.
Definition: FMUInfo.h:44
oms::Component::type
oms_component_enu_t type
Definition: Component.h:167
oms::DirectedGraph
Definition: DirectedGraph.h:64
oms::Component::setGeometry
void setGeometry(const ssd::ElementGeometry &geometry)
Definition: Component.h:125
oms::Element::setTLMBusConnectors
void setTLMBusConnectors(oms::TLMBusConnector **newTLMBusConnectors)
Definition: Element.cpp:90
Clock.h
Element.h
oms::Component::~Component
virtual ~Component()
Definition: Component.cpp:87
oms::Component::deleteConnector
oms_status_enu_t deleteConnector(const ComRef &cref)
Definition: Component.cpp:184
oms::ssp::Draft20180219::ssd::connector
const char * connector
Definition: Tags.cpp:49
oms::Component::terminate
virtual oms_status_enu_t terminate()=0
SignalDerivative.h
logDebug
#define logDebug(msg)
Definition: Logging.h:109
oms::Component::setFaultInjection
virtual oms_status_enu_t setFaultInjection(const ComRef &signal, oms_fault_type_enu_t faultType, double faultValue)
Definition: Component.h:98
oms::Component::initialize
virtual oms_status_enu_t initialize()=0
oms::Values
Definition: Values.h:45
oms::Component::getTLMBusConnector
oms::TLMBusConnector * getTLMBusConnector(const oms::ComRef &cref)
Definition: Component.cpp:127
oms::Component::getFilteredEnumerationDefinitionsToSSD
virtual void getFilteredEnumerationDefinitionsToSSD(std::map< std::string, std::map< std::string, std::string >> &enumerationDefinitions)
Definition: Component.h:68
oms::Component
Definition: Component.h:59
oms::Component::setTempDir
void setTempDir(const std::string &tempDir)
Definition: Component.h:120
oms::Component::reset
virtual oms_status_enu_t reset()=0
logWarning
#define logWarning(msg)
Definition: Logging.h:101
oms::ssd::ElementGeometry
Definition: ElementGeometry.h:45
ResultWriter.h
oms::Component::values
Values values
Definition: Component.h:170
oms::Component::getBoolean
virtual oms_status_enu_t getBoolean(const ComRef &cref, bool &value)
Definition: Component.h:89
oms::Snapshot
Definition: Snapshot.h:46
oms::Component::updateOrDeleteStartValueInReplacedComponent
virtual oms_status_enu_t updateOrDeleteStartValueInReplacedComponent(std::vector< std::string > &warningList)
Definition: Component.h:85
oms::Component::element
Element element
Definition: Component.h:154
Component.h
oms::ResultWriter
Definition: ResultWriter.h:68
oms::Element::setGeometry
void setGeometry(const oms::ssd::ElementGeometry *newGeometry)
Definition: Element.cpp:67
oms::Component::getAllResources
void getAllResources(std::vector< std::string > &resources) const
Definition: Component.h:116
oms::Component::getConnectors
Connector ** getConnectors()
Definition: Component.h:114
oms::Component::operator=
Component & operator=(Component const &)
not implemented
oms::Component::getInitialUnknownsGraph
const DirectedGraph & getInitialUnknownsGraph()
Definition: Component.h:135
oms::Component::updateSignals
virtual oms_status_enu_t updateSignals(ResultWriter &resultWriter)=0
oms::Component::exportToSSV
virtual oms_status_enu_t exportToSSV(pugi::xml_node &ssvNode)
Definition: Component.h:66
oms::Component::getTempDir
const std::string & getTempDir() const
Definition: Component.h:118
oms::ssp::Draft20180219::ssd::connectors
const char * connectors
Definition: Tags.cpp:51
oms::Component::getTLMBusConnectors
TLMBusConnector ** getTLMBusConnectors()
Definition: Component.h:130
Connector.h
oms::Component::getPath
const std::string & getPath() const
Definition: Component.h:117
oms::Component::setString
virtual oms_status_enu_t setString(const ComRef &cref, const std::string &value)
Definition: Component.h:101
oms::Component::setPath
void setPath(const std::string &newPath)
Definition: Component.h:119
LOG_NO_TLM
#define LOG_NO_TLM()
Definition: TLMInterface.h:36
oms::Component::getType
oms_component_enu_t getType() const
Definition: Component.h:121
oms::Component::getReal
virtual oms_status_enu_t getReal(const ComRef &cref, double &value)
Definition: Component.h:91
oms::Component::freeState
virtual oms_status_enu_t freeState()
Definition: Component.h:88
oms::Component::exportToSSMTemplate
virtual oms_status_enu_t exportToSSMTemplate(pugi::xml_node &ssmNode)
Definition: Component.h:86
oms::Component::clock
Clock clock
Definition: Component.h:160
oms::System
Definition: System.h:65
oms::ssp::Draft20180219::bus
const char * bus
Definition: Tags.cpp:36
oms::Component::restoreState
virtual oms_status_enu_t restoreState()
Definition: Component.h:95
oms::Component::setRealInputDerivative
virtual oms_status_enu_t setRealInputDerivative(const ComRef &cref, const SignalDerivative &der)
Definition: Component.h:103
logError
#define logError(msg)
Definition: Logging.h:102
oms::Component::getOutputsGraph
const DirectedGraph & getOutputsGraph()
Definition: Component.h:136
oms::Element::setConnectors
void setConnectors(oms::Connector **newConnectors)
Definition: Element.cpp:79
oms::Component::getFMUInfo
virtual const FMUInfo * getFMUInfo() const
Definition: Component.h:80
oms::Component::renameValues
virtual oms_status_enu_t renameValues(const ComRef &oldCref, const ComRef &newCref)
Definition: Component.h:149
oms::Component::deleteReferencesInSSD
virtual oms_status_enu_t deleteReferencesInSSD(const std::string &filename)
Definition: Component.h:107
oms::Component::deleteStartValue
virtual oms_status_enu_t deleteStartValue(const ComRef &cref)
Definition: Component.h:81
oms::Component::getInteger
virtual oms_status_enu_t getInteger(const ComRef &cref, int &value)
Definition: Component.h:90
oms::Component::removeSignalsFromResults
virtual oms_status_enu_t removeSignalsFromResults(const char *regex)=0
oms::Component::getParentSystem
System * getParentSystem() const
Definition: Component.h:123
oms::Variable
Definition: Variable.h:45
Flags.h
oms::Connector
Connector.
Definition: Connector.h:49
Logging.h
oms::TLMBusConnector
TLMBusConnector.
Definition: TLMBusConnector.h:96
oms::Component::saveState
virtual oms_status_enu_t saveState()
Definition: Component.h:96
oms::Component::getModel
Model & getModel() const
Definition: Component.cpp:105
oms::Component::initialUnknownsGraph
DirectedGraph initialUnknownsGraph
Definition: Component.h:152
logError_TlmBusNotInComponent
#define logError_TlmBusNotInComponent(cref, component)
Definition: Logging.h:151
OMSFileSystem.h
oms::Component::instantiate
virtual oms_status_enu_t instantiate()=0
oms::ssp::Draft20180219::signal
const char * signal
Definition: Tags.cpp:38
oms::Component::getCanGetAndSetState
virtual bool getCanGetAndSetState()
Definition: Component.h:79
oms::Component::Component
Component(const ComRef &cref, oms_component_enu_t type, System *parentSystem, const std::string &path)
Definition: Component.cpp:75
oms::Component::stepUntil
virtual oms_status_enu_t stepUntil(double stopTime)
Definition: Component.h:104
oms::Component::getValuesResources
virtual std::vector< Values > getValuesResources()
Definition: Component.h:82
oms::Component::setValuesResources
virtual oms_status_enu_t setValuesResources(Values &values)
Definition: Component.h:84
oms::fmi2logger
void fmi2logger(fmi2ComponentEnvironment env, fmi2String instanceName, fmi2Status status, fmi2String category, fmi2String message,...)
Definition: Component.cpp:42
FMUInfo.h
Values.h
oms::Component::exportToSSVTemplate
virtual oms_status_enu_t exportToSSVTemplate(pugi::xml_node &ssvNode, Snapshot &snapshot)
Definition: Component.h:87
oms::Component::clock_id
unsigned int clock_id
Definition: Component.h:161
oms::Component::deleteConnectorFromTLMBus
oms_status_enu_t deleteConnectorFromTLMBus(const ComRef &busCref, const ComRef &connectorCref)
Definition: Component.cpp:162
oms::Component::tempDir
std::string tempDir
unzipped fmu
Definition: Component.h:169
oms::Component::deleteResourcesInSSP
virtual oms_status_enu_t deleteResourcesInSSP(const std::string &filename)
Definition: Component.h:108
oms::Component::getCref
const ComRef & getCref() const
Definition: Component.h:110
oms::Component::path
std::string path
resource file (fmu, mat)
Definition: Component.h:168