Skip to content

Commit 6936484

Browse files
authored
Merge pull request #95 from alliander-opensource/bugfix/outputs-are-not-required
'Required' is not applicable to output fields
2 parents 59b5a5d + ef57356 commit 6936484

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

docs/graph-data-model.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ The base type for all power grid components.
152152
| name | data type | unit | description | required | input | update | output |
153153
| --- | --- | --- | --- | :---: | :---: | :---: | :---: |
154154
| `id` | `int32_t` | - | ID of a component, the id should be unique along all components, i.e. you cannot have a node with `id` 5 and a line with `id` 5. | ✔ | ✔ | ❌ (id needs to be specified in the update query, but cannot be changed) | ✔ |
155-
| `energized` | `int8_t` | - | Indicates if a component is energized, i.e. connected to a source | ✔ | ❌ | ❌ | ✔ |
155+
| `energized` | `int8_t` | - | Indicates if a component is energized, i.e. connected to a source | | ❌ | ❌ | ✔ |
156156

157157
## Node
158158

@@ -163,9 +163,9 @@ The base type for all power grid components.
163163
| name | data type | unit | description | required | input | update | output | valid values |
164164
| --- | --- | --- | --- | :---: | :---: | :---: | :---: | :---: |
165165
| `u_rated` | `double` | volt (V) | rated line-line voltage | ✔ | ✔ | ❌ | ❌ | `> 0` |
166-
| `u_pu` | `RealValueOutput` | - | per-unit voltage magnitude | ✔ | ❌ | ❌ | ✔ | |
167-
| `u_angle` | `RealValueOutput` | rad | voltage angle | ✔ | ❌ | ❌ | ✔ | |
168-
| `u` | `RealValueOutput` | volt (V) | voltage magnitude, line-line for symmetric calculation, line-neutral for asymmetric calculation | ✔ | ❌ | ❌ | ✔ | |
166+
| `u_pu` | `RealValueOutput` | - | per-unit voltage magnitude | | ❌ | ❌ | ✔ | |
167+
| `u_angle` | `RealValueOutput` | rad | voltage angle | | ❌ | ❌ | ✔ | |
168+
| `u` | `RealValueOutput` | volt (V) | voltage magnitude, line-line for symmetric calculation, line-neutral for asymmetric calculation | | ❌ | ❌ | ✔ | |
169169

170170

171171
## Branch
@@ -184,15 +184,15 @@ In this case, the attribute `from_status` and `to_status` is always 1.
184184
| `to_node` | `int32_t` | - | ID of node at to-side | ✔ | ✔ | ❌ | ❌ | a valid node id |
185185
| `from_status` | `int8_t` | - | connection status at from-side | ✔ | ✔ | ✔ | ❌ | `0` or `1` |
186186
| `to_status` | `int8_t` | - | connection status at to-side | ✔ | ✔ | ✔ | ❌ | `0` or `1` |
187-
| `p_from` | `RealValueOutput` | watt (W) | active power flowing into the branch at from-side | ✔ | ❌ | ❌ | ✔ | |
188-
| `q_from` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power flowing into the branch at from-side | ✔ | ❌ | ❌ | ✔ | |
189-
| `i_from` | `RealValueOutput` | ampere (A) | current at from-side | ✔ | ❌ | ❌ | ✔ | |
190-
| `s_from` | `RealValueOutput` | volt-ampere (VA) | apparent power flowing at from-side | ✔ | ❌ | ❌ | ✔ | |
191-
| `p_to` | `RealValueOutput` | watt (W) | active power flowing into the branch at to-side | ✔ | ❌ | ❌ | ✔ | |
192-
| `q_to` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power flowing into the branch at to-side | ✔ | ❌ | ❌ | ✔ | |
193-
| `i_to` | `RealValueOutput` | ampere (A) | current at to-side | ✔ | ❌ | ❌ | ✔ | |
194-
| `s_to` | `RealValueOutput` | volt-ampere (VA) | apparent power flowing at to-side | ✔ | ❌ | ❌ | ✔ | |
195-
| `loading` | `double` | - | relative loading of the line, `1.0` meaning 100% loaded. | ✔ | ❌ | ❌ | ✔ | |
187+
| `p_from` | `RealValueOutput` | watt (W) | active power flowing into the branch at from-side | | ❌ | ❌ | ✔ | |
188+
| `q_from` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power flowing into the branch at from-side | | ❌ | ❌ | ✔ | |
189+
| `i_from` | `RealValueOutput` | ampere (A) | current at from-side | | ❌ | ❌ | ✔ | |
190+
| `s_from` | `RealValueOutput` | volt-ampere (VA) | apparent power flowing at from-side | | ❌ | ❌ | ✔ | |
191+
| `p_to` | `RealValueOutput` | watt (W) | active power flowing into the branch at to-side | | ❌ | ❌ | ✔ | |
192+
| `q_to` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power flowing into the branch at to-side | | ❌ | ❌ | ✔ | |
193+
| `i_to` | `RealValueOutput` | ampere (A) | current at to-side | | ❌ | ❌ | ✔ | |
194+
| `s_to` | `RealValueOutput` | volt-ampere (VA) | apparent power flowing at to-side | | ❌ | ❌ | ✔ | |
195+
| `loading` | `double` | - | relative loading of the line, `1.0` meaning 100% loaded. | | ❌ | ❌ | ✔ | |
196196

197197

198198
### Line
@@ -275,11 +275,11 @@ For each `appliance` a switch is defined between the `appliance` and the `node`.
275275
| --- | --- | --- | --- | :---: | :---: | :---: | :---: | :---: |
276276
| `node` | `int32_t` | - | ID of the coupled node | ✔ | ✔ | ❌ | ❌ | a valid node id |
277277
| `status` | `int8_t` | - | connection status to the node | ✔ | ✔ | ✔ | ❌ | `0` or `1` |
278-
| `p` | `RealValueOutput` | watt (W) | active power | ✔ | ❌ | ❌ | ✔ | |
279-
| `q` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power | ✔ | ❌ | ❌ | ✔ | |
280-
| `i` | `RealValueOutput` | ampere (A) | current | ✔ | ❌ | ❌ | ✔ | |
281-
| `s` | `RealValueOutput` | volt-ampere (VA) | apparent power | ✔ | ❌ | ❌ | ✔ | |
282-
| `pf` | `RealValueOutput` | - | power factor | ✔ | ❌ | ❌ | ✔ | |
278+
| `p` | `RealValueOutput` | watt (W) | active power | | ❌ | ❌ | ✔ | |
279+
| `q` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power | | ❌ | ❌ | ✔ | |
280+
| `i` | `RealValueOutput` | ampere (A) | current | | ❌ | ❌ | ✔ | |
281+
| `s` | `RealValueOutput` | volt-ampere (VA) | apparent power | | ❌ | ❌ | ✔ | |
282+
| `pf` | `RealValueOutput` | - | power factor | | ❌ | ❌ | ✔ | |
283283

284284
### Source
285285

@@ -387,8 +387,8 @@ The table below shows a list of attributes.
387387
| --- | --- | --- | --- | :---: | :---: | :---: | :---: | :---: |
388388
| `u_measured` | `RealValueInput` | volt (V) | measured voltage magnitude | ✨ only for state estimation | ✔ | ✔ | ❌ | `> 0` |
389389
| `u_angle_measured` | `RealValueInput` | rad | measured voltage angle (only possible with phasor measurement units) |❌ | ✔ | ✔ | ❌ | |
390-
| `u_residual` | `RealValueOutput` | volt (V) | residual value between measured voltage magnitude and calculated voltage magnitude | ✔ | ❌ | ❌ | ✔ | |
391-
| `u_angle_residual` | `RealValueOutput` | rad | residual value between measured voltage angle and calculated voltage angle (only possible with phasor measurement units) | ❌ | ❌ | ❌ | ✔ | |
390+
| `u_residual` | `RealValueOutput` | volt (V) | residual value between measured voltage magnitude and calculated voltage magnitude | | ❌ | ❌ | ✔ | |
391+
| `u_angle_residual` | `RealValueOutput` | rad | residual value between measured voltage angle and calculated voltage angle (only possible with phasor measurement units) | | ❌ | ❌ | ✔ | |
392392

393393

394394
### Generic Power Sensor
@@ -427,5 +427,5 @@ The table below shows a list of attributes.
427427
| --- | --- | --- | --- | :---: | :---: | :---: | :---: |
428428
| `p_measured` | `RealValueInput` | watt (W) | measured active power | ✨ only for state estimation | ✔ | ✔ | ❌ |
429429
| `q_measured` | `RealValueInput` | volt-ampere-reactive (var) | measured reactive power | ✨ only for state estimation | ✔ | ✔ | ❌ |
430-
| `p_residual` | `RealValueOutput` | watt (W) | residual value between measured active power and calculated active power | ✔ | ❌ | ❌ | ✔ |
431-
| `q_residual` | `RealValueOutput` | volt-ampere-reactive (var) | residual value between measured reactive power and calculated reactive power | ✔ | ❌ | ❌ | ✔ |
430+
| `p_residual` | `RealValueOutput` | watt (W) | residual value between measured active power and calculated active power | | ❌ | ❌ | ✔ |
431+
| `q_residual` | `RealValueOutput` | volt-ampere-reactive (var) | residual value between measured reactive power and calculated reactive power | | ❌ | ❌ | ✔ |

0 commit comments

Comments
 (0)