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 "Snapshot.h"
42 #include "OMSimulator/Types.h"
43 #include "Variable.h"
44 #include <vector>
45 #include <map>
46 
47 namespace oms
48 {
49  class ExternalModel : public Component
50  {
51  public:
53  static ExternalModel* NewComponent(const oms::ComRef& cref, System* parentSystem, const std::string& path, const std::string& startscript);
54 
55  const ExternalModelInfo *getExternalModelInfo() const {return &(this->externalModelInfo);}
56 
58  oms_status_enu_t setRealParameter(const std::string& var, double value);
59  oms_status_enu_t getRealParameter(const std::string& var, double& value);
60  const std::string getStartScript() const {return externalModelInfo.getStartScript();}
61  const std::map<std::string, oms::Option<double>>& getRealParameters() const {return realParameters;}
62 
63  oms_status_enu_t exportToSSD(pugi::xml_node& node, Snapshot& snapshot, std::string variantName) const;
64  oms_status_enu_t instantiate();
65  oms_status_enu_t initialize();
66  oms_status_enu_t terminate();
67  oms_status_enu_t reset();
68 
69  oms_status_enu_t updateDependencyGraphs() {return oms_status_error;}
70 
71  oms_status_enu_t registerSignalsForResultFile(ResultWriter& resultFile);
72  oms_status_enu_t updateSignals(ResultWriter& resultWriter);
73  oms_status_enu_t addSignalsToResults(const char* regex);
74  oms_status_enu_t removeSignalsFromResults(const char* regex);
75 
76  void getFilteredSignals(std::vector<Connector>& filteredSignals) const {}
77 
78  protected:
79  ExternalModel(const oms::ComRef& cref, System* parentSystem, const std::string& path, const std::string& startscript);
80 
81  // stop the compiler generating methods copying the object
82  ExternalModel(ExternalModel const& copy);
83  ExternalModel& operator=(ExternalModel const& copy);
84 
85  private:
87  std::map<std::string, oms::Option<double>> realParameters;
88  };
89 }
90 
91 #endif
oms::ExternalModel::addSignalsToResults
oms_status_enu_t addSignalsToResults(const char *regex)
Definition: ExternalModel.cpp:146
Option.h
oms
Definition: AlgLoop.h:44
oms::Component::cref
ComRef cref
Definition: Component.h:166
ComRef.h
oms::ExternalModel::exportToSSD
oms_status_enu_t exportToSSD(pugi::xml_node &node, Snapshot &snapshot, std::string variantName) const
Definition: ExternalModel.cpp:90
oms::ComRef
ComRef - component reference.
Definition: ComRef.h:46
oms::ExternalModel::terminate
oms_status_enu_t terminate()
Definition: ExternalModel.cpp:126
oms::ExternalModel::reset
oms_status_enu_t reset()
Definition: ExternalModel.cpp:131
oms::ExternalModel::realParameters
std::map< std::string, oms::Option< double > > realParameters
Definition: ExternalModel.h:87
oms::Component::parentSystem
System * parentSystem
Definition: Component.h:165
oms::ExternalModel::instantiate
oms_status_enu_t instantiate()
Definition: ExternalModel.cpp:116
logError_NotImplemented
#define logError_NotImplemented
Definition: Logging.h:141
oms::ExternalModel::updateDependencyGraphs
oms_status_enu_t updateDependencyGraphs()
Definition: ExternalModel.h:69
Snapshot.h
oms::ExternalModelInfo
External model info.
Definition: ExternalModelInfo.h:44
oms::ExternalModel::updateSignals
oms_status_enu_t updateSignals(ResultWriter &resultWriter)
Definition: ExternalModel.cpp:141
oms::ExternalModel::getFilteredSignals
void getFilteredSignals(std::vector< Connector > &filteredSignals) const
Definition: ExternalModel.h:76
Element.h
oms::ExternalModel::ExternalModel
ExternalModel(const oms::ComRef &cref, System *parentSystem, const std::string &path, const std::string &startscript)
Definition: ExternalModel.cpp:43
oms::Component
Definition: Component.h:59
oms::ExternalModel::removeSignalsFromResults
oms_status_enu_t removeSignalsFromResults(const char *regex)
Definition: ExternalModel.cpp:151
oms::ExternalModel::operator=
ExternalModel & operator=(ExternalModel const &copy)
not implemented
oms::ExternalModel::registerSignalsForResultFile
oms_status_enu_t registerSignalsForResultFile(ResultWriter &resultFile)
Definition: ExternalModel.cpp:136
oms::ExternalModel::getExternalModelInfo
const ExternalModelInfo * getExternalModelInfo() const
Definition: ExternalModel.h:55
ResultWriter.h
oms::Snapshot
Definition: Snapshot.h:46
Component.h
oms::ResultWriter
Definition: ResultWriter.h:68
oms::ExternalModel::externalModelInfo
ExternalModelInfo externalModelInfo
Definition: ExternalModel.h:86
oms::ExternalModel::getStartScript
const std::string getStartScript() const
Definition: ExternalModel.h:60
oms::ExternalModel
Definition: ExternalModel.h:49
oms::ExternalModel::initialize
oms_status_enu_t initialize()
Definition: ExternalModel.cpp:121
oms::System
Definition: System.h:65
oms::ExternalModel::getRealParameters
const std::map< std::string, oms::Option< double > > & getRealParameters() const
Definition: ExternalModel.h:61
oms::ExternalModel::setRealParameter
oms_status_enu_t setRealParameter(const std::string &var, double value)
Definition: ExternalModel.cpp:64
oms::ExternalModelInfo::getStartScript
std::string getStartScript() const
Definition: ExternalModelInfo.h:51
oms::ExternalModel::NewComponent
static ExternalModel * NewComponent(const oms::ComRef &cref, System *parentSystem, const std::string &path, const std::string &startscript)
Definition: ExternalModel.cpp:52
oms::ExternalModel::getVariable
Variable * getVariable(const ComRef &cref)
Definition: ExternalModel.h:57
oms::Variable
Definition: Variable.h:45
oms::ExternalModel::~ExternalModel
~ExternalModel()
Definition: ExternalModel.cpp:48
oms::ExternalModel::getRealParameter
oms_status_enu_t getRealParameter(const std::string &var, double &value)
Definition: ExternalModel.cpp:77
Variable.h
ExternalModelInfo.h
oms::Component::path
std::string path
resource file (fmu, mat)
Definition: Component.h:168