OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
ResultWriter.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_RESULTWRITER_H_
33 #define _OMS_RESULTWRITER_H_
34 
35 #include "ComRef.h"
36 #include <string>
37 #include <vector>
38 
39 namespace oms
40 {
42  {
46  };
47 
49  {
50  double realValue;
51  int intValue;
52  bool boolValue;
53  };
54 
55  struct Signal
56  {
58  std::string description;
60  };
61 
62  struct Parameter
63  {
66  };
67 
69  {
70  public:
71  ResultWriter(unsigned int bufferSize);
72  virtual ~ResultWriter();
73 
74  unsigned int addSignal(const ComRef& name, const std::string& description, SignalType_t type);
75  void addParameter(const ComRef& name, const std::string& description, SignalType_t type, SignalValue_t value);
76 
77  bool create(const std::string& filename, double startTime, double stopTime);
78  void close();
79 
80  void updateSignal(unsigned int id, SignalValue_t value);
81  void emit(double time);
82 
83  private:
84  // Stop the compiler generating methods for copying the object
85  ResultWriter(ResultWriter const& copy); // Not Implemented
86  ResultWriter& operator=(ResultWriter const& copy); // Not Implemented
87 
88  protected:
89  virtual bool createFile(const std::string& filename, double startTime, double stopTime) = 0;
90  virtual void closeFile() = 0;
91  virtual void writeFile() = 0;
92 
93  std::vector<Signal> signals;
94  std::vector<Parameter> parameters;
95 
96  double* data_2;
97  unsigned int bufferSize;
98  unsigned int nEmits;
99  };
100 
101  class VoidWriter :
102  public ResultWriter
103  {
104  public:
107 
108  protected:
109  bool createFile(const std::string& filename, double startTime, double stopTime) {return true;}
110  void closeFile() {}
111  void writeFile() {}
112  };
113 }
114 
115 #endif
oms
Definition: AlgLoop.h:44
ComRef.h
oms::VoidWriter::writeFile
void writeFile()
Definition: ResultWriter.h:111
oms::Model
Definition: Model.h:52
oms::ComRef::front
ComRef front() const
returns the first part of the ComRef (including suffix if its the only part)
Definition: ComRef.cpp:166
Model.h
oms::ComRef
ComRef - component reference.
Definition: ComRef.h:46
oms::ssp::Version1_0::ssv::parameter
const char * parameter
Definition: Tags.cpp:81
oms::VoidWriter::VoidWriter
VoidWriter(unsigned int bufferSize)
Definition: ResultWriter.h:105
oms::SignalType_INT
@ SignalType_INT
Definition: ResultWriter.h:44
oms::Signal::type
SignalType_t type
Definition: ResultWriter.h:59
oms::ResultWriter::ResultWriter
ResultWriter(unsigned int bufferSize)
Definition: ResultWriter.cpp:37
oms::Signal
Definition: ResultWriter.h:55
oms::SignalType_REAL
@ SignalType_REAL
Definition: ResultWriter.h:43
oms::ssp::Version1_0::ssv::parameters
const char * parameters
Definition: Tags.cpp:80
oms::ssp::Draft20180219::signals
const char * signals
Definition: Tags.cpp:37
oms::SignalValue_t::realValue
double realValue
Definition: ResultWriter.h:50
oms::Parameter
Definition: ResultWriter.h:62
oms::ResultWriter::signals
std::vector< Signal > signals
Definition: ResultWriter.h:93
oms::Model::isIsolatedFMUModel
bool isIsolatedFMUModel() const
Definition: Model.h:128
oms::ResultWriter::~ResultWriter
virtual ~ResultWriter()
Definition: ResultWriter.cpp:44
oms::VoidWriter
Definition: ResultWriter.h:101
oms::SignalType_BOOL
@ SignalType_BOOL
Definition: ResultWriter.h:45
oms::ResultWriter::nEmits
unsigned int nEmits
Definition: ResultWriter.h:98
oms::VoidWriter::closeFile
void closeFile()
Definition: ResultWriter.h:110
oms::ResultWriter::closeFile
virtual void closeFile()=0
oms::Scope::GetInstance
static Scope & GetInstance()
Definition: Scope.cpp:63
oms::ResultWriter::bufferSize
unsigned int bufferSize
Definition: ResultWriter.h:97
oms::ResultWriter::operator=
ResultWriter & operator=(ResultWriter const &copy)
oms::SignalValue_t
Definition: ResultWriter.h:48
oms::Parameter::signal
Signal signal
Definition: ResultWriter.h:64
oms::SignalType_t
SignalType_t
Definition: ResultWriter.h:41
oms::Flags::StripRoot
static bool StripRoot()
Definition: Flags.h:74
oms::ResultWriter::emit
void emit(double time)
Definition: ResultWriter.cpp:139
ResultWriter.h
oms::ResultWriter::close
void close()
Definition: ResultWriter.cpp:106
oms::ResultWriter
Definition: ResultWriter.h:68
oms::Scope::getModel
Model * getModel(const ComRef &cref)
Definition: Scope.cpp:404
oms::ResultWriter::data_2
double * data_2
Definition: ResultWriter.h:96
Scope.h
oms::Parameter::value
SignalValue_t value
Definition: ResultWriter.h:65
oms::Signal::name
ComRef name
Definition: ResultWriter.h:57
oms::ResultWriter::updateSignal
void updateSignal(unsigned int id, SignalValue_t value)
Definition: ResultWriter.cpp:120
oms::ResultWriter::addSignal
unsigned int addSignal(const ComRef &name, const std::string &description, SignalType_t type)
Definition: ResultWriter.cpp:50
oms::SignalValue_t::intValue
int intValue
Definition: ResultWriter.h:51
oms::ResultWriter::writeFile
virtual void writeFile()=0
Flags.h
oms::VoidWriter::~VoidWriter
~VoidWriter()
Definition: ResultWriter.h:106
oms::VoidWriter::createFile
bool createFile(const std::string &filename, double startTime, double stopTime)
Definition: ResultWriter.h:109
oms::ResultWriter::createFile
virtual bool createFile(const std::string &filename, double startTime, double stopTime)=0
oms::ssp::Draft20180219::signal
const char * signal
Definition: Tags.cpp:38
oms::ResultWriter::parameters
std::vector< Parameter > parameters
Definition: ResultWriter.h:94
oms::ResultWriter::create
bool create(const std::string &filename, double startTime, double stopTime)
Definition: ResultWriter.cpp:96
oms::SignalValue_t::boolValue
bool boolValue
Definition: ResultWriter.h:52
oms::Signal::description
std::string description
Definition: ResultWriter.h:58
oms::ResultWriter::addParameter
void addParameter(const ComRef &name, const std::string &description, SignalType_t type, SignalValue_t value)
Definition: ResultWriter.cpp:73