Skip to content

IIDM & XIIDM 1.2 evolutions

Anne Tilloy edited this page Jun 8, 2021 · 16 revisions

New features

Apparent power attribute for TwoWindingsTransformer and ThreeWindingsTransformer.Leg

A new optional attribute ratedS in TwoWindingsTransformer and ThreeWindingsTransformer.Leg has been introduced to model apparent power. If ratedS is not set to Double.NaN, it should be strictly positive.

Regulation for ShuntCompensator

Shunt compensators can now be regulated. New attributes (regulation (boolean), targetV (double), targetDeadband (double) and regulatingTerminal (Terminal)) have been added to ShuntCompensator and can be set and accessed. However, to serialize or deserialize a shunt compensator with any of these attributes with a non-default value, IIDM-XML version 1.1 must be used. Otherwise, the serialization and deserialization will fail.

To know more about these attributes and their default values, go to the documentation page of ShuntCompensator.

Any Identifiable can be fictitious, not only Switch

fictitious is now an optional boolean attribute for every classes extending Identifiable. For any Identifiable, you can now use:

identifiable.setFictitious(true);
boolean fictitious = identifiable.isFictitious();

If you are using a custom implementation, be sure to implement this method in order not to throw an UnsupportedOperationException.

Add voltageLevel.hasAttachedEquipment(int node) method

This new method specifies if there is any electrical equipment, a switch or an internal connection attached to a given node in a voltage level.

If you are using a custom implementation, be sure to implement this method in order not to throw an UnsupportedOperationException.

Changes and fixes

targetDeadband attribute in RatioTapChanger and PhaseTapChanger

The attribute targetDeadband in RatioTapChanger and PhaseTapChanger is now required if RatioTapChanger.regulating is set to true or PhaseTapChanger.regulationMode is not set to FIXED_TAP.

If targetDeadband is not defined in these cases, an exception will be thrown. Hence, add the line:

tapChangerAdder.setTargetDeadband(0.0);

to keep the same behavior as before. Of course, you can also add another value if it is more appropriate to your use case. At any rate, in the cases described above, targetDeadband should not be Double.NaN.

Deletion of nodeCount attribute in nodeBreakerTopology

The attribute nodeCount in the nodeBreakerTopology element has been deleted from this IIDM-XML version: it is not possible to pre-create vertices in the voltage level's graph in advance as this design was prone to allocation errors. Graph's vertices are created on the fly while attaching network components (a connectable equipment, a switch or an internal connection). When reading an IIDM-XML file in a prior version, the attribute nodeCount will be ignored. When writing an IIDM-XML file in a prior version, the attribute nodeCount will be written based on the number of vertices in the voltage level's graph.

lossFactor convention

The attribute lossFactor in the LCC or VSC converter stations is not a ratio anymore but a percentage. In the previous version, there was no integrity test on its value, but since IIDM-XML v1.2, its value should be positive, and less than 100. We consider this as a breaking change because the results of a simulation could be different.

Clone this wiki locally