OMSimulatorLib The OMSimulator project is a FMI-based co-simulation environment.

Loading...
Searching...
No Matches
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 "SignalDerivative.h"
40#include "Snapshot.h"
41#include <map>
42#include <pugixml.hpp>
43#include <string>
44#include <unordered_map>
45#include <vector>
46
47 namespace oms
48{
49 class ComponentTable : public Component
50 {
51 public:
52 ~ComponentTable();
53
54 static Component* NewComponent(const oms::ComRef& cref, System* parentSystem, const std::string& path);
55 static Component* NewComponent(const pugi::xml_node& node, System* parentSystem, const std::string& sspVersion, const Snapshot& snapshot);
56
57 oms_status_enu_t exportToSSD(pugi::xml_node& node, Snapshot& snapshot, std::string variantName) const;
58 oms_status_enu_t exportToSSVTemplate(pugi::xml_node& ssvNode) {return oms_status_ok;}
59 oms_status_enu_t exportToSSMTemplate(pugi::xml_node& ssmNode) {return oms_status_ok;}
60 oms_status_enu_t instantiate();
61 oms_status_enu_t initialize() {return oms_status_ok;}
62 oms_status_enu_t terminate() {return oms_status_ok;}
63 oms_status_enu_t reset();
64
65 oms_status_enu_t stepUntil(double stopTime) {time = stopTime; return oms_status_ok;}
66 oms_status_enu_t setTime(double time) {this->time = time; return oms_status_ok;}
67
68 Variable* getVariable(const ComRef& cref) {logError_NotImplemented; return NULL;}
69 oms_status_enu_t getReal(const ComRef& cref, double& value);
70 oms_status_enu_t getRealOutputDerivative(const ComRef& cref, SignalDerivative& value);
71 oms_status_enu_t getInteger(const ComRef& cref, int& value);
72 oms_status_enu_t getBoolean(const ComRef& cref, bool& value);
73
74 oms_status_enu_t registerSignalsForResultFile(ResultWriter& resultFile);
75 oms_status_enu_t updateSignals(ResultWriter& resultWriter);
76 oms_status_enu_t addSignalsToResults(const char* regex);
77 oms_status_enu_t removeSignalsFromResults(const char* regex);
78
79 bool getCanGetAndSetState() {return true;}
80 oms_status_enu_t saveState();
81 oms_status_enu_t freeState();
82 oms_status_enu_t restoreState();
83
84 void getFilteredSignals(std::vector<Connector>& filteredSignals) const;
85
86 protected:
87 ComponentTable(const ComRef& cref, System* parentSystem, const std::string& path);
88
89 // stop the compiler generating methods copying the object
90 ComponentTable(ComponentTable const& copy);
91 ComponentTable& operator=(ComponentTable const& copy);
92
93 private:
94 ResultReader* resultReader;
95 std::unordered_map<ComRef, ResultReader::Series*> series;
96 std::unordered_map<ComRef, bool> exportSeries;
97 std::unordered_map<unsigned int /*result file var ID*/, unsigned int /*allVariables ID*/> resultFileMapping;
98 double time;
99 double storedTime;
100 size_t lastIndex = 0;
101 };
102}
103
104#endif
ComRef.h
Component.h
logError_NotImplemented
#define logError_NotImplemented
Definition Logging.h:107
ResultReader.h
ResultWriter.h
SignalDerivative.h
Snapshot.h
oms::ComRef
ComRef - component reference.
Definition ComRef.h:47
oms::ComponentTable
Definition ComponentTable.h:50
oms::ComponentTable::resultReader
ResultReader * resultReader
Definition ComponentTable.h:94
oms::ComponentTable::series
std::unordered_map< ComRef, ResultReader::Series * > series
Definition ComponentTable.h:95
oms::ComponentTable::~ComponentTable
~ComponentTable()
Definition ComponentTable.cpp:47
oms::ComponentTable::restoreState
oms_status_enu_t restoreState()
Definition ComponentTable.cpp:429
oms::ComponentTable::removeSignalsFromResults
oms_status_enu_t removeSignalsFromResults(const char *regex)
Definition ComponentTable.cpp:403
oms::ComponentTable::NewComponent
static Component * NewComponent(const oms::ComRef &cref, System *parentSystem, const std::string &path)
Definition ComponentTable.cpp:57
oms::ComponentTable::getInteger
oms_status_enu_t getInteger(const ComRef &cref, int &value)
Definition ComponentTable.cpp:235
oms::ComponentTable::getBoolean
oms_status_enu_t getBoolean(const ComRef &cref, bool &value)
Definition ComponentTable.cpp:276
oms::ComponentTable::exportToSSVTemplate
oms_status_enu_t exportToSSVTemplate(pugi::xml_node &ssvNode)
Definition ComponentTable.h:58
oms::ComponentTable::setTime
oms_status_enu_t setTime(double time)
Definition ComponentTable.h:66
oms::ComponentTable::getRealOutputDerivative
oms_status_enu_t getRealOutputDerivative(const ComRef &cref, SignalDerivative &value)
Definition ComponentTable.cpp:317
oms::ComponentTable::exportToSSMTemplate
oms_status_enu_t exportToSSMTemplate(pugi::xml_node &ssmNode)
Definition ComponentTable.h:59
oms::ComponentTable::initialize
oms_status_enu_t initialize()
Definition ComponentTable.h:61
oms::ComponentTable::ComponentTable
ComponentTable(ComponentTable const &copy)
not implemented
oms::ComponentTable::time
double time
Definition ComponentTable.h:98
oms::ComponentTable::reset
oms_status_enu_t reset()
Definition ComponentTable.cpp:187
oms::ComponentTable::addSignalsToResults
oms_status_enu_t addSignalsToResults(const char *regex)
Definition ComponentTable.cpp:388
oms::ComponentTable::operator=
ComponentTable & operator=(ComponentTable const &copy)
not implemented
oms::ComponentTable::storedTime
double storedTime
Definition ComponentTable.h:99
oms::ComponentTable::exportToSSD
oms_status_enu_t exportToSSD(pugi::xml_node &node, Snapshot &snapshot, std::string variantName) const
Definition ComponentTable.cpp:164
oms::ComponentTable::updateSignals
oms_status_enu_t updateSignals(ResultWriter &resultWriter)
Definition ComponentTable.cpp:372
oms::ComponentTable::getVariable
Variable * getVariable(const ComRef &cref)
Definition ComponentTable.h:68
oms::ComponentTable::resultFileMapping
std::unordered_map< unsigned int, unsigned int > resultFileMapping
Definition ComponentTable.h:97
oms::ComponentTable::getFilteredSignals
void getFilteredSignals(std::vector< Connector > &filteredSignals) const
Definition ComponentTable.cpp:435
oms::ComponentTable::freeState
oms_status_enu_t freeState()
Definition ComponentTable.cpp:424
oms::ComponentTable::stepUntil
oms_status_enu_t stepUntil(double stopTime)
Definition ComponentTable.h:65
oms::ComponentTable::terminate
oms_status_enu_t terminate()
Definition ComponentTable.h:62
oms::ComponentTable::saveState
oms_status_enu_t saveState()
Definition ComponentTable.cpp:418
oms::ComponentTable::registerSignalsForResultFile
oms_status_enu_t registerSignalsForResultFile(ResultWriter &resultFile)
Definition ComponentTable.cpp:355
oms::ComponentTable::exportSeries
std::unordered_map< ComRef, bool > exportSeries
Definition ComponentTable.h:96
oms::ComponentTable::getCanGetAndSetState
bool getCanGetAndSetState()
Definition ComponentTable.h:79
oms::ComponentTable::getReal
oms_status_enu_t getReal(const ComRef &cref, double &value)
Definition ComponentTable.cpp:193
oms::ComponentTable::instantiate
oms_status_enu_t instantiate()
Definition ComponentTable.cpp:181
oms::ComponentTable::lastIndex
size_t lastIndex
Definition ComponentTable.h:100
oms::Component
Definition Component.h:60
oms::Component::path
std::string path
resource file (fmu, mat)
Definition Component.h:156
oms::Component::cref
ComRef cref
Definition Component.h:154
oms::Component::parentSystem
System * parentSystem
Definition Component.h:153
oms::ResultReader
Definition ResultReader.h:41
oms::ResultWriter
Definition ResultWriter.h:69
oms::SignalDerivative
Definition SignalDerivative.h:42
oms::Snapshot
Definition Snapshot.h:47
oms::System
Definition System.h:62
oms::Variable
Definition Variable.h:46
oms
Definition AlgLoop.h:45