Interface BusbarSectionPosition
- All Superinterfaces:
Extension<BusbarSection>
- All Known Implementing Classes:
BusbarSectionPositionImpl
Position information about the BusbarSection
- within the corresponding busbar (
getSectionIndex()
) - relative to other busbars of the voltage level (
getBusbarIndex()
)
Note that a busbar is a set of BusbarSections. Hence, the BusbarSections of a same busbar should have the same busbar index. The busbar indices induce an order of busbars within the voltage level, which usually reflects the busbars physical relative positions.
Similarly, the section indices induce an order of BusbarSections of a same busbar, which usually reflects their physical relative position.
Note that, when used in conjunction with ConnectablePosition
, the busbar
described by several BusBarSections having the same section index should have ascending connectable positions for
ascending section indices.
- Author:
- Jon Harper <jon.harper at rte-france.com>
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Return the index of the corresponding busbar among the busbars of the voltage leveldefault String
getName()
Return the name of this extension.int
Return the index of the busbar section within the corresponding busbarsetBusbarIndex
(int busbarIndex) setSectionIndex
(int sectionIndex) Methods inherited from interface com.powsybl.commons.extensions.Extension
getExtendable, setExtendable
-
Field Details
-
NAME
- See Also:
-
-
Method Details
-
getName
Description copied from interface:Extension
Return the name of this extension.- Specified by:
getName
in interfaceExtension<BusbarSection>
-
getBusbarIndex
int getBusbarIndex()Return the index of the corresponding busbar among the busbars of the voltage level -
setBusbarIndex
-
getSectionIndex
int getSectionIndex()Return the index of the busbar section within the corresponding busbar -
setSectionIndex
-