OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
ExternalModel.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_EXTERNAL_MODEL_H_
33 #define _OMS_EXTERNAL_MODEL_H_
34 
35 #include "Component.h"
36 #include "ComRef.h"
37 #include "Element.h"
38 #include "ExternalModelInfo.h"
39 #include "Option.h"
40 #include "ResultWriter.h"
41 #include "Types.h"
42 #include "Variable.h"
43 #include <vector>
44 #include <map>
45 
46 namespace oms
47 {
48  class ExternalModel : public Component
49  {
50  public:
52  static ExternalModel* NewComponent(const oms::ComRef& cref, System* parentSystem, const std::string& path, const std::string& startscript);
53 
54  const ExternalModelInfo *getExternalModelInfo() const {return &(this->externalModelInfo);}
55 
56  Variable* getVariable(const ComRef& cref) {logError_NotImplemented; return NULL;}
57  oms_status_enu_t setRealParameter(const std::string& var, double value);
58  oms_status_enu_t getRealParameter(const std::string& var, double& value);
59  const std::string getStartScript() const {return externalModelInfo.getStartScript();}
60  const std::map<std::string, oms::Option<double>>& getRealParameters() const {return realParameters;}
61 
62  oms_status_enu_t exportToSSD(pugi::xml_node& node, pugi::xml_node& ssvNode) const;
67 
69 
72  oms_status_enu_t addSignalsToResults(const char* regex);
73  oms_status_enu_t removeSignalsFromResults(const char* regex);
74 
75  protected:
76  ExternalModel(const oms::ComRef& cref, System* parentSystem, const std::string& path, const std::string& startscript);
77 
78  // stop the compiler generating methods copying the object
79  ExternalModel(ExternalModel const& copy);
80  ExternalModel& operator=(ExternalModel const& copy);
81 
82  private:
84  std::map<std::string, oms::Option<double>> realParameters;
85  };
86 }
87 
88 #endif
const std::string getStartScript() const
Definition: ExternalModel.h:59
oms_status_enu_t updateDependencyGraphs()
Definition: ExternalModel.h:68
oms_status_enu_t initialize()
Definition: ExternalModel.cpp:121
~ExternalModel()
Definition: ExternalModel.cpp:48
Definition: ResultWriter.h:68
System * parentSystem
Definition: Component.h:143
oms_status_enu_t registerSignalsForResultFile(ResultWriter &resultFile)
Definition: ExternalModel.cpp:136
Definition: Variable.h:44
oms_status_enu_t instantiate()
Definition: ExternalModel.cpp:116
std::string path
resource file (fmu, mat)
Definition: Component.h:146
oms_status_enu_t updateSignals(ResultWriter &resultWriter)
Definition: ExternalModel.cpp:141
oms_status_enu_t
Definition: Types.h:43
oms_status_enu_t addSignalsToResults(const char *regex)
Definition: ExternalModel.cpp:146
oms_status_enu_t setRealParameter(const std::string &var, double value)
Definition: ExternalModel.cpp:64
ExternalModel(const oms::ComRef &cref, System *parentSystem, const std::string &path, const std::string &startscript)
Definition: ExternalModel.cpp:43
Definition: ExternalModel.h:48
oms_status_enu_t terminate()
Definition: ExternalModel.cpp:126
Definition: Types.h:47
ComRef - component reference.
Definition: ComRef.h:43
Definition: Component.h:56
const std::map< std::string, oms::Option< double > > & getRealParameters() const
Definition: ExternalModel.h:60
oms_status_enu_t removeSignalsFromResults(const char *regex)
Definition: ExternalModel.cpp:151
Definition: AlgLoop.h:44
std::map< std::string, oms::Option< double > > realParameters
Definition: ExternalModel.h:84
#define logError_NotImplemented
Definition: Logging.h:142
External model info.
Definition: ExternalModelInfo.h:44
ComRef cref
Definition: Component.h:144
const ExternalModelInfo * getExternalModelInfo() const
Definition: ExternalModel.h:54
static ExternalModel * NewComponent(const oms::ComRef &cref, System *parentSystem, const std::string &path, const std::string &startscript)
Definition: ExternalModel.cpp:52
oms_status_enu_t reset()
Definition: ExternalModel.cpp:131
ExternalModelInfo externalModelInfo
Definition: ExternalModel.h:83
std::string getStartScript() const
Definition: ExternalModelInfo.h:51
Definition: System.h:67
oms_status_enu_t getRealParameter(const std::string &var, double &value)
Definition: ExternalModel.cpp:77
oms_status_enu_t exportToSSD(pugi::xml_node &node, pugi::xml_node &ssvNode) const
Definition: ExternalModel.cpp:90
Variable * getVariable(const ComRef &cref)
Definition: ExternalModel.h:56
ExternalModel & operator=(ExternalModel const &copy)
not implemented