powsybl-core
powsybl-core copied to clipboard
Incoherence between documentation and code on IIDM Branch
The interface com.powsybl.iidm.network.Branch javadoc don't match the code of Branch (and all 3 implementations Line, TieLine and TwoWindingsTransformer):
- it say that
xandrare properties of a branch, but the getters aren't declared in it but incom.powsybl.iidm.network.LineCharacteristicsfor Line+TieLine and directly in TwoWindingsTransformer - it say that
b1,b2,g1andg2are also commons properties but it's only declared in LineCharacteristics but not in TwoWindingsTransformer where we have insteadbandg.
So
- is
x&rreally common properties of branches? If yes can it be declared in Branch interface instead because we have otherwise to cast/instanceof on subtypes to access the getters... - the documentation need to be updated for other properties it seems.
PS: haven't found if its also write somewhere in the (html) documentation outside of javadoc.