OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
Variable.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_VARIABLE_H_
33 #define _OMS_VARIABLE_H_
34 
35 #include "ComRef.h"
36 #include "Connector.h"
37 #include "Types.h"
38 
39 #include <fmilib.h>
40 #include <string>
41 #include <vector>
42 
43 namespace oms
44 {
45  class Variable
46  {
47  public:
48  Variable(fmi2_import_variable_t* var);
49  ~Variable();
50 
51  void markAsState(size_t der_index) { is_state = true; this->der_index = der_index; }
52  void markAsContinuousTimeState(size_t der_index) { is_continuous_time_state = true; this->der_index = der_index; }
54 
55  unsigned int getStateIndex() const { return state_index; }
56 
57  // causality attribute
58  bool isParameter() const { return fmi2_causality_enu_parameter == causality; }
59  bool isCalculatedParameter() const { return fmi2_causality_enu_calculated_parameter == causality; }
60  bool isInput() const { return fmi2_causality_enu_input == causality; }
61  bool isOutput() const { return fmi2_causality_enu_output == causality; }
62  bool isLocal() const { return fmi2_causality_enu_local == causality; }
63  bool isState() const { return is_state; }
64  bool isDer() const { return is_der; }
67  bool isIndependent() const { return fmi2_causality_enu_independent == causality; }
68 
69  // initial attribute
70  bool isExact() const { return fmi2_initial_enu_exact == initialProperty; }
71  bool isApprox() const { return fmi2_initial_enu_approx == initialProperty; }
72  bool isCalculated() const { return fmi2_initial_enu_calculated == initialProperty; }
73 
74  bool isInitialUnknown() const {
75  return (isOutput() && (isApprox() || isCalculated()))
78  || (isContinuousTimeDer() && (isApprox() || isCalculated()));
79  }
80 
81  const ComRef& getCref() const { return cref; }
82  operator std::string() const { return std::string(cref); }
83 
84  fmi2_value_reference_t getValueReference() const { return vr; }
85  oms_signal_type_enu_t getType() const { return type; }
86  const std::string& getDescription() const { return description; }
87 
88  bool isTypeBoolean() const { return oms_signal_type_boolean == type; }
90  bool isTypeReal() const { return oms_signal_type_real == type; }
91  bool isTypeString() const { return oms_signal_type_string == type; }
92 
93  std::string getCausalityString() const { return std::string(fmi2_causality_to_string(causality)); }
95 
96  unsigned int getIndex() const { return index; }
97  oms::Connector makeConnector(const oms::ComRef& owner) const { return oms::Connector(getCausality(), type, cref, owner); }
98 
99  private:
101  std::string description;
102  fmi2_value_reference_t vr;
103  fmi2_causality_enu_t causality;
104  fmi2_variability_enu_t variability;
105  fmi2_initial_enu_t initialProperty;
106  bool is_state;
107  bool is_der;
111  unsigned int index;
112  size_t state_index;
113  size_t der_index;
114 
115  friend bool operator==(const oms::Variable& v1, const oms::Variable& v2);
116  friend bool operator!=(const oms::Variable& v1, const oms::Variable& v2);
117  };
118 
119  bool operator==(const oms::Variable& v1, const oms::Variable& v2);
120  bool operator!=(const oms::Variable& v1, const oms::Variable& v2);
121 }
122 
123 #endif
ComRef cref
Definition: Variable.h:100
std::string getCausalityString() const
Definition: Variable.h:93
bool isInitialUnknown() const
Definition: Variable.h:74
oms_signal_type_enu_t getType() const
Definition: Variable.h:85
bool isTypeBoolean() const
Definition: Variable.h:88
const ComRef & getCref() const
Definition: Variable.h:81
Definition: Variable.h:45
bool is_continuous_time_state
Definition: Variable.h:108
bool isIndependent() const
Definition: Variable.h:67
oms_signal_type_enu_t type
Definition: Variable.h:110
oms_causality_enu_t
Definition: Types.h:61
bool is_der
Definition: Variable.h:107
bool isState() const
Definition: Variable.h:63
const std::string & getDescription() const
Definition: Variable.h:86
bool isOutput() const
Definition: Variable.h:61
Variable(fmi2_import_variable_t *var)
Definition: Variable.cpp:40
void markAsContinuousTimeState(size_t der_index)
Definition: Variable.h:52
bool isInput() const
Definition: Variable.h:60
fmi2_value_reference_t vr
Definition: Variable.h:102
size_t state_index
index origin = 0
Definition: Variable.h:112
fmi2_variability_enu_t variability
Definition: Variable.h:104
bool isCalculated() const
Definition: Variable.h:72
bool isApprox() const
Definition: Variable.h:71
ComRef - component reference.
Definition: ComRef.h:46
unsigned int getIndex() const
Definition: Variable.h:96
bool isLocal() const
Definition: Variable.h:62
Connector.
Definition: Connector.h:49
Definition: Types.h:137
fmi2_initial_enu_t initialProperty
Definition: Variable.h:105
size_t der_index
index origin = 0
Definition: Variable.h:113
Definition: Types.h:138
bool isContinuousTimeState() const
Definition: Variable.h:65
oms_signal_type_enu_t
Definition: Types.h:135
oms_causality_enu_t getCausality() const
Definition: Variable.cpp:91
Definition: Types.h:140
bool isContinuousTimeDer() const
Definition: Variable.h:66
Definition: AlgLoop.h:44
bool isCalculatedParameter() const
Definition: Variable.h:59
unsigned int index
index origin = 0
Definition: Variable.h:111
void markAsContinuousTimeDer()
Definition: Variable.h:53
Definition: Types.h:139
bool isExact() const
Definition: Variable.h:70
void markAsState(size_t der_index)
Definition: Variable.h:51
bool isDer() const
Definition: Variable.h:64
bool is_state
Definition: Variable.h:106
oms::Connector makeConnector(const oms::ComRef &owner) const
Definition: Variable.h:97
bool isTypeInteger() const
Definition: Variable.h:89
Definition: Types.h:136
bool isTypeString() const
Definition: Variable.h:91
unsigned int getStateIndex() const
Definition: Variable.h:55
~Variable()
Definition: Variable.cpp:87
bool isTypeReal() const
Definition: Variable.h:90
fmi2_value_reference_t getValueReference() const
Definition: Variable.h:84
fmi2_causality_enu_t causality
Definition: Variable.h:103
friend bool operator!=(const oms::Variable &v1, const oms::Variable &v2)
friend bool operator==(const oms::Variable &v1, const oms::Variable &v2)
bool is_continuous_time_der
Definition: Variable.h:109
std::string description
Definition: Variable.h:101
bool isParameter() const
Definition: Variable.h:58