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 "OMSimulator/Types.h"
38 
39 #include <fmi4c.h>
40 #include <string>
41 #include <vector>
42 
43 namespace oms
44 {
45  class Variable
46  {
47  public:
48  Variable(fmiHandle * fmi4c, int index);
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 fmi2CausalityParameter == causality; }
59  bool isCalculatedParameter() const { return fmi2CausalityCalculatedParameter == causality; }
60  bool isInput() const { return fmi2CausalityInput == causality; }
61  bool isOutput() const { return fmi2CausalityOutput == causality; }
62  bool isLocal() const { return fmi2CausalityLocal == causality; }
63  bool isIndependent() const { return fmi2CausalityIndependent == causality; }
64 
65  bool isState() const { return is_state; }
66  bool isDer() const { return is_der; }
69 
70  // initial attribute
71  bool isExact() const { return fmi2InitialExact == initialProperty; }
72  bool isApprox() const { return fmi2InitialApprox == initialProperty; }
73  bool isCalculated() const { return fmi2InitialCalculated == initialProperty; }
74 
75  bool isInitialUnknown() const {
76  return (isOutput() && (isApprox() || isCalculated()))
79  || (isContinuousTimeDer() && (isApprox() || isCalculated()));
80  }
81 
82  const ComRef& getCref() const { return cref; }
83  operator std::string() const { return std::string(cref); }
84 
85  fmi2ValueReference getValueReference() const { return vr; }
86  oms_signal_type_enu_t getType() const { return type; }
87  const std::string& getDescription() const { return description; }
88 
89  bool isTypeBoolean() const { return oms_signal_type_boolean == type; }
90  bool isTypeInteger() const { return oms_signal_type_integer == type || oms_signal_type_enum == type; }
91  bool isTypeReal() const { return oms_signal_type_real == type; }
92  bool isTypeString() const { return oms_signal_type_string == type; }
93 
94  std::string getCausalityString() const;
95  oms_causality_enu_t getCausality() const;
96 
97  unsigned int getIndex() const { return index; }
98  oms::Connector makeConnector(const oms::ComRef& owner) const { return oms::Connector(getCausality(), type, cref, owner); }
99 
100  private:
102  std::string description;
103  fmi2ValueReference vr;
104  fmi2Causality causality;
105  fmi2Variability variability;
106  fmi2Initial initialProperty;
107 
108  bool is_state;
109  bool is_der;
112  oms_signal_type_enu_t type;
113  unsigned int index;
114  size_t state_index;
115  size_t der_index;
116 
117  friend bool operator==(const oms::Variable& v1, const oms::Variable& v2);
118  friend bool operator!=(const oms::Variable& v1, const oms::Variable& v2);
119  };
120 
121  bool operator==(const oms::Variable& v1, const oms::Variable& v2);
122  bool operator!=(const oms::Variable& v1, const oms::Variable& v2);
123 }
124 
125 #endif
oms::Variable::causality
fmi2Causality causality
Definition: Variable.h:104
oms::Variable::isApprox
bool isApprox() const
Definition: Variable.h:72
oms::Variable::markAsContinuousTimeState
void markAsContinuousTimeState(size_t der_index)
Definition: Variable.h:52
oms
Definition: AlgLoop.h:44
Util.h
oms::Variable::getCausalityString
std::string getCausalityString() const
Definition: Variable.cpp:115
ComRef.h
oms::Variable::isExact
bool isExact() const
Definition: Variable.h:71
oms::Variable::state_index
size_t state_index
index origin = 0
Definition: Variable.h:114
oms::Variable::isTypeInteger
bool isTypeInteger() const
Definition: Variable.h:90
oms::ComRef
ComRef - component reference.
Definition: ComRef.h:46
oms::Variable::getValueReference
fmi2ValueReference getValueReference() const
Definition: Variable.h:85
oms::Variable::isIndependent
bool isIndependent() const
Definition: Variable.h:63
oms::Variable::getType
oms_signal_type_enu_t getType() const
Definition: Variable.h:86
oms::Variable::vr
fmi2ValueReference vr
Definition: Variable.h:103
oms::Variable::isContinuousTimeDer
bool isContinuousTimeDer() const
Definition: Variable.h:68
oms::Variable::isLocal
bool isLocal() const
Definition: Variable.h:62
oms::Variable::isParameter
bool isParameter() const
Definition: Variable.h:58
oms::Variable::markAsState
void markAsState(size_t der_index)
Definition: Variable.h:51
trim
static void trim(std::string &s)
Definition: Util.h:58
oms::Variable::isDer
bool isDer() const
Definition: Variable.h:66
oms::Variable::isInput
bool isInput() const
Definition: Variable.h:60
oms::Variable::cref
ComRef cref
Definition: Variable.h:101
oms::Variable::isTypeReal
bool isTypeReal() const
Definition: Variable.h:91
oms::operator==
bool operator==(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:210
oms::Variable::index
unsigned int index
index origin = 0
Definition: Variable.h:113
oms::Variable::is_continuous_time_state
bool is_continuous_time_state
Definition: Variable.h:110
oms::Variable::isTypeBoolean
bool isTypeBoolean() const
Definition: Variable.h:89
oms::Variable::getCausality
oms_causality_enu_t getCausality() const
Definition: Variable.cpp:94
oms::Variable::variability
fmi2Variability variability
Definition: Variable.h:105
oms::Variable::operator!=
friend bool operator!=(const oms::Variable &v1, const oms::Variable &v2)
oms::Variable::operator==
friend bool operator==(const oms::Variable &v1, const oms::Variable &v2)
oms::Variable::isOutput
bool isOutput() const
Definition: Variable.h:61
oms::operator!=
bool operator!=(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:215
Connector.h
oms::Variable::initialProperty
fmi2Initial initialProperty
Definition: Variable.h:106
oms::Variable::isInitialUnknown
bool isInitialUnknown() const
Definition: Variable.h:75
oms::Variable::markAsContinuousTimeDer
void markAsContinuousTimeDer()
Definition: Variable.h:53
oms::Variable::der_index
size_t der_index
index origin = 0
Definition: Variable.h:115
oms::Variable::getCref
const ComRef & getCref() const
Definition: Variable.h:82
oms::Variable::~Variable
~Variable()
Definition: Variable.cpp:90
oms::Variable::getStateIndex
unsigned int getStateIndex() const
Definition: Variable.h:55
oms::Variable::isCalculated
bool isCalculated() const
Definition: Variable.h:73
oms::Variable::isContinuousTimeState
bool isContinuousTimeState() const
Definition: Variable.h:67
oms::Variable::is_der
bool is_der
Definition: Variable.h:109
oms::Variable::isState
bool isState() const
Definition: Variable.h:65
logError
#define logError(msg)
Definition: Logging.h:102
oms::Variable::is_state
bool is_state
Definition: Variable.h:108
oms::Variable::isTypeString
bool isTypeString() const
Definition: Variable.h:92
oms::Variable::Variable
Variable(fmiHandle *fmi4c, int index)
Definition: Variable.cpp:37
oms::Variable::getDescription
const std::string & getDescription() const
Definition: Variable.h:87
oms::Variable::makeConnector
oms::Connector makeConnector(const oms::ComRef &owner) const
Definition: Variable.h:98
oms::Variable::isCalculatedParameter
bool isCalculatedParameter() const
Definition: Variable.h:59
oms::Variable
Definition: Variable.h:45
oms::Connector
Connector.
Definition: Connector.h:49
Logging.h
oms::Variable::type
oms_signal_type_enu_t type
Definition: Variable.h:112
Variable.h
oms::Variable::getIndex
unsigned int getIndex() const
Definition: Variable.h:97
oms::Variable::is_continuous_time_der
bool is_continuous_time_der
Definition: Variable.h:111
oms::Variable::description
std::string description
Definition: Variable.h:102