-
Notifications
You must be signed in to change notification settings - Fork 5
/
SystemParticipantInput.java
208 lines (180 loc) · 6.09 KB
/
SystemParticipantInput.java
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*
* © 2021. TU Dortmund University,
* Institute of Energy Systems, Energy Efficiency and Energy Economics,
* Research group Distribution grid planning and operation
*/
package edu.ie3.datamodel.models.input.system;
import edu.ie3.datamodel.io.extractor.HasEm;
import edu.ie3.datamodel.io.extractor.HasNodes;
import edu.ie3.datamodel.models.OperationTime;
import edu.ie3.datamodel.models.UniqueEntity;
import edu.ie3.datamodel.models.input.AssetInput;
import edu.ie3.datamodel.models.input.EmInput;
import edu.ie3.datamodel.models.input.NodeInput;
import edu.ie3.datamodel.models.input.OperatorInput;
import edu.ie3.datamodel.models.input.system.characteristic.ReactivePowerCharacteristic;
import java.util.*;
/** Describes a system asset that is connected to a node */
public abstract class SystemParticipantInput extends AssetInput implements HasNodes, HasEm {
/** The node that the asset is connected to */
private final NodeInput node;
/** Description of a reactive power characteristic. For details see further documentation */
private final ReactivePowerCharacteristic qCharacteristics;
/**
* Optional {@link EmInput} that is controlling this system participant. If null, this system
* participant is not em-controlled.
*/
private final EmInput controllingEm;
/**
* Constructor for an operated system participant
*
* @param uuid of the input entity
* @param id of the asset
* @param operator of the asset
* @param operationTime Time for which the entity is operated
* @param node that the asset is connected to
* @param qCharacteristics Description of a reactive power characteristic
* @param em The {@link EmInput} controlling this system participant. Null, if not applicable.
*/
protected SystemParticipantInput(
UUID uuid,
String id,
OperatorInput operator,
OperationTime operationTime,
NodeInput node,
ReactivePowerCharacteristic qCharacteristics,
EmInput em) {
super(uuid, id, operator, operationTime);
this.node = node;
this.qCharacteristics = qCharacteristics;
this.controllingEm = em;
}
/**
* Constructor for an operated, always on system participant
*
* @param uuid of the input entity
* @param id of the asset
* @param node that the asset is connected to
* @param qCharacteristics Description of a reactive power characteristic
* @param em The {@link EmInput} controlling this system participant. Null, if not applicable.
*/
protected SystemParticipantInput(
UUID uuid,
String id,
NodeInput node,
ReactivePowerCharacteristic qCharacteristics,
EmInput em) {
super(uuid, id);
this.node = node;
this.qCharacteristics = qCharacteristics;
this.controllingEm = em;
}
public NodeInput getNode() {
return node;
}
public ReactivePowerCharacteristic getqCharacteristics() {
return qCharacteristics;
}
/*
public Optional<EmInput> getEm() {
return Optional.ofNullable(em);
}
*/
@Override
public List<NodeInput> allNodes() {
return Collections.singletonList(node);
}
@Override
public Optional<EmInput> getControllingEm() {
return Optional.ofNullable(controllingEm);
}
@Override
public abstract SystemParticipantInputCopyBuilder<?> copy();
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof SystemParticipantInput that)) return false;
if (!super.equals(o)) return false;
return Objects.equals(node, that.node)
&& Objects.equals(qCharacteristics, that.qCharacteristics)
&& Objects.equals(controllingEm, that.controllingEm);
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), node, qCharacteristics, controllingEm);
}
@Override
public String toString() {
return "SystemParticipantInput{"
+ "uuid="
+ getUuid()
+ ", id="
+ getId()
+ ", operator="
+ getOperator().getUuid()
+ ", operationTime="
+ getOperationTime()
+ ", node="
+ node.getUuid()
+ ", qCharacteristics='"
+ qCharacteristics
+ "', em="
+ getControllingEm().map(UniqueEntity::getUuid).map(UUID::toString).orElse("")
+ '}';
}
/**
* Abstract class for all builder that build child entities of abstract class {@link
* SystemParticipantInput}
*
* @version 0.1
* @since 05.06.20
*/
public abstract static class SystemParticipantInputCopyBuilder<
B extends SystemParticipantInputCopyBuilder<B>>
extends AssetInputCopyBuilder<B> {
private NodeInput node;
private ReactivePowerCharacteristic qCharacteristics;
private EmInput em;
protected SystemParticipantInputCopyBuilder(SystemParticipantInput entity) {
super(entity);
this.node = entity.getNode();
this.qCharacteristics = entity.getqCharacteristics();
this.em = entity.getControllingEm().orElse(null);
}
public B node(NodeInput node) {
this.node = node;
return thisInstance();
}
public B qCharacteristics(ReactivePowerCharacteristic qCharacteristics) {
this.qCharacteristics = qCharacteristics;
return thisInstance();
}
public B em(EmInput em) {
this.em = em;
return thisInstance();
}
protected NodeInput getNode() {
return node;
}
protected ReactivePowerCharacteristic getqCharacteristics() {
return qCharacteristics;
}
/** @return The {@link EmInput} controlling this system participant. CAN BE NULL. */
public EmInput getEm() {
return em;
}
/**
* Scales the input entity in a way that tries to preserve proportions that are related to
* power. This means that capacity, consumption etc. are scaled with the same factor. Related
* properties associated with the input type (if applicable) are scaled as well.
*
* @param factor The factor to scale with
* @return A copy builder with scaled relevant properties
*/
public abstract B scale(Double factor);
@Override
public abstract SystemParticipantInput build();
@Override
protected abstract B thisInstance();
}
}