OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
ComponentTable.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_TABLE_H_
33 #define _OMS_COMPONENT_TABLE_H_
34 
35 #include "Component.h"
36 #include "ComRef.h"
37 #include "ResultReader.h"
38 #include "ResultWriter.h"
39 #include <fmilib.h>
40 #include <map>
41 #include <pugixml.hpp>
42 #include <string>
43 #include <unordered_map>
44 #include <vector>
45 
46 namespace oms
47 {
48  class ComponentTable : public Component
49  {
50  public:
52 
53  static Component* NewComponent(const oms::ComRef& cref, System* parentSystem, const std::string& path);
54  static Component* NewComponent(const pugi::xml_node& node, System* parentSystem);
55 
56  oms_status_enu_t exportToSSD(pugi::xml_node& node) const;
61 
62  oms_status_enu_t stepUntil(double stopTime) {time = stopTime; return oms_status_ok;}
63 
64  oms_status_enu_t getReal(const ComRef& cref, double& value);
65 
68  oms_status_enu_t addSignalsToResults(const char* regex);
69  oms_status_enu_t removeSignalsFromResults(const char* regex);
70 
71  protected:
72  ComponentTable(const ComRef& cref, System* parentSystem, const std::string& path);
73 
74  // stop the compiler generating methods copying the object
75  ComponentTable(ComponentTable const& copy);
77 
78  private:
80  std::unordered_map<ComRef, ResultReader::Series*> series;
81  std::unordered_map<ComRef, bool> exportSeries;
82  std::unordered_map<unsigned int /*result file var ID*/, unsigned int /*allVariables ID*/> resultFileMapping;
83  double time;
84  };
85 }
86 
87 #endif
oms_status_enu_t instantiate()
Definition: ComponentTable.cpp:172
Definition: Types.h:44
Definition: ResultWriter.h:67
oms_status_enu_t registerSignalsForResultFile(ResultWriter &resultFile)
Definition: ComponentTable.cpp:212
System * parentSystem
Definition: Component.h:126
oms_status_enu_t addSignalsToResults(const char *regex)
Definition: ComponentTable.cpp:246
std::unordered_map< ComRef, bool > exportSeries
Definition: ComponentTable.h:81
ComponentTable(const ComRef &cref, System *parentSystem, const std::string &path)
Definition: ComponentTable.cpp:41
double time
Definition: ComponentTable.h:83
std::string path
Definition: Component.h:129
oms_status_enu_t
Definition: Types.h:43
ResultReader * resultReader
Definition: ComponentTable.h:79
oms_status_enu_t initialize()
Definition: ComponentTable.h:58
std::unordered_map< ComRef, ResultReader::Series * > series
Definition: ComponentTable.h:80
oms_status_enu_t reset()
Definition: ComponentTable.cpp:178
ComRef - component reference.
Definition: ComRef.h:43
Definition: Component.h:54
oms_status_enu_t updateSignals(ResultWriter &resultWriter)
Definition: ComponentTable.cpp:230
std::unordered_map< unsigned int, unsigned int > resultFileMapping
Definition: ComponentTable.h:82
static Component * NewComponent(const oms::ComRef &cref, System *parentSystem, const std::string &path)
Definition: ComponentTable.cpp:56
Definition: BusConnector.h:15
Definition: ResultReader.h:40
oms_status_enu_t exportToSSD(pugi::xml_node &node) const
Definition: ComponentTable.cpp:155
ComRef cref
Definition: Component.h:127
oms_status_enu_t getReal(const ComRef &cref, double &value)
Definition: ComponentTable.cpp:184
~ComponentTable()
Definition: ComponentTable.cpp:46
oms_status_enu_t terminate()
Definition: ComponentTable.h:59
oms_status_enu_t stepUntil(double stopTime)
Definition: ComponentTable.h:62
Definition: System.h:58
ComponentTable & operator=(ComponentTable const &copy)
not implemented
oms_status_enu_t removeSignalsFromResults(const char *regex)
Definition: ComponentTable.cpp:264
Definition: ComponentTable.h:48