Package com.powsybl.iidm.network.extensions

Interface ConnectablePosition<C extends Connectable<C>>

All Superinterfaces:

Extension<C>

All Known Implementing Classes:

ConnectablePositionImpl

public interface ConnectablePosition<C extends Connectable<C>>
extends Extension<C>

This class gives some information for visualization tools, for a given connectable:

• its position relative to other equipments in its voltage level(s),
• its direction relative to the corresponding busbar section(s) (top or bottom - as the busbar section is usually displayed horizontally - or undefined),
• its display name(s).

This gives visualization tools suggestions for displaying the equipments within a voltage level. The information is given through one, two or three ConnectablePosition.Feeder objects, as the connectable might be between two or three busbar sections (which may or may not be in the same voltage level).

Note that, when this class is used in conjunction with BusbarSectionPosition, the connectable positions should be in ascending order for ascending busbar section indices. That is, the connectable positions should be in ascending order on a given physical busbar.

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ConnectablePosition.Direction
static interface	ConnectablePosition.Feeder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Method Summary

Modifier and Type	Method	Description
static void	check(ConnectablePosition.Feeder feeder, ConnectablePosition.Feeder feeder1, ConnectablePosition.Feeder feeder2, ConnectablePosition.Feeder feeder3)
ConnectablePosition.Feeder	getFeeder()	Feeder in case the connectable has only one (injections)
ConnectablePosition.Feeder	getFeeder1()	First feeder in case the connectable has two or three
ConnectablePosition.Feeder	getFeeder2()	Second feeder in case the connectable has two or three
ConnectablePosition.Feeder	getFeeder3()	Third feeder in case the connectable has three (three windings transformers)
default String	getName()	Return the name of this extension.

Methods inherited from interface com.powsybl.commons.extensions.Extension

getExtendable, setExtendable

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

getName

default String getName()

Description copied from interface: Extension

Return the name of this extension.

Specified by:

getName in interface Extension<C extends Connectable<C>>

getFeeder

ConnectablePosition.Feeder getFeeder()

Feeder in case the connectable has only one (injections)

getFeeder1

ConnectablePosition.Feeder getFeeder1()

First feeder in case the connectable has two or three

getFeeder2

ConnectablePosition.Feeder getFeeder2()

Second feeder in case the connectable has two or three

getFeeder3

ConnectablePosition.Feeder getFeeder3()

Third feeder in case the connectable has three (three windings transformers)

check

static void check(ConnectablePosition.Feeder feeder,
 ConnectablePosition.Feeder feeder1,
 ConnectablePosition.Feeder feeder2,
 ConnectablePosition.Feeder feeder3)