-
Notifications
You must be signed in to change notification settings - Fork 49
/
Variable.h
125 lines (105 loc) · 4.72 KB
/
Variable.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
* This file is part of OpenModelica.
*
* Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
* c/o Linköpings universitet, Department of Computer and Information Science,
* SE-58183 Linköping, Sweden.
*
* All rights reserved.
*
* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
* THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
* ACCORDING TO RECIPIENTS CHOICE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from OSMC, either from the above address,
* from the URLs: http://www.ida.liu.se/projects/OpenModelica or
* http://www.openmodelica.org, and in the OpenModelica distribution.
* GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
*
* This program is distributed WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
* IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
*
* See the full OSMC Public License conditions for more details.
*
*/
#ifndef _OMS_VARIABLE_H_
#define _OMS_VARIABLE_H_
#include "ComRef.h"
#include "Connector.h"
#include "OMSimulator/Types.h"
#include <fmi4c.h>
#include <string>
#include <vector>
namespace oms
{
class Variable
{
public:
Variable(fmiHandle * fmi4c, int index);
~Variable();
void markAsState(size_t der_index) { is_state = true; this->der_index = der_index; }
void markAsContinuousTimeState(size_t der_index) { is_continuous_time_state = true; this->der_index = der_index; }
void markAsContinuousTimeDer() { is_continuous_time_der = true; }
unsigned int getStateIndex() const { return state_index; }
// causality attribute
bool isParameter() const { return fmi2CausalityParameter == causality; }
bool isCalculatedParameter() const { return fmi2CausalityCalculatedParameter == causality; }
bool isInput() const { return fmi2CausalityInput == causality; }
bool isOutput() const { return fmi2CausalityOutput == causality; }
bool isLocal() const { return fmi2CausalityLocal == causality; }
bool isIndependent() const { return fmi2CausalityIndependent == causality; }
bool isState() const { return is_state; }
bool isDer() const { return is_der; }
bool isContinuousTimeState() const { return is_continuous_time_state; }
bool isContinuousTimeDer() const { return is_continuous_time_der; }
// initial attribute
bool isExact() const { return fmi2InitialExact == initialProperty; }
bool isApprox() const { return fmi2InitialApprox == initialProperty; }
bool isCalculated() const { return fmi2InitialCalculated == initialProperty; }
bool isInitialUnknown() const {
return (isOutput() && (isApprox() || isCalculated()))
|| (isCalculatedParameter())
|| (isContinuousTimeState() && (isApprox() || isCalculated()))
|| (isContinuousTimeDer() && (isApprox() || isCalculated()));
}
const ComRef& getCref() const { return cref; }
operator std::string() const { return std::string(cref); }
fmi2ValueReference getValueReference() const { return vr; }
oms_signal_type_enu_t getType() const { return type; }
const std::string& getDescription() const { return description; }
bool isTypeBoolean() const { return oms_signal_type_boolean == type; }
bool isTypeInteger() const { return oms_signal_type_integer == type || oms_signal_type_enum == type; }
bool isTypeReal() const { return oms_signal_type_real == type; }
bool isTypeString() const { return oms_signal_type_string == type; }
std::string getCausalityString() const;
oms_causality_enu_t getCausality() const;
unsigned int getIndex() const { return index; }
oms::Connector makeConnector(const oms::ComRef& owner) const { return oms::Connector(getCausality(), type, cref, owner); }
private:
ComRef cref;
std::string description;
fmi2ValueReference vr;
fmi2Causality causality;
fmi2Variability variability;
fmi2Initial initialProperty;
bool is_state;
bool is_der;
bool is_continuous_time_state;
bool is_continuous_time_der;
oms_signal_type_enu_t type;
unsigned int index; ///< index origin = 0
size_t state_index; ///< index origin = 0
size_t der_index; ///< index origin = 0
friend bool operator==(const oms::Variable& v1, const oms::Variable& v2);
friend bool operator!=(const oms::Variable& v1, const oms::Variable& v2);
};
bool operator==(const oms::Variable& v1, const oms::Variable& v2);
bool operator!=(const oms::Variable& v1, const oms::Variable& v2);
}
#endif