Interface BusbarSectionPosition
-
- All Superinterfaces:
Extension<BusbarSection>
- All Known Implementing Classes:
BusbarSectionPositionImpl
public interface BusbarSectionPosition extends Extension<BusbarSection>
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.
- Author:
- Jon Harper
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description int
getBusbarIndex()
Return the index of the corresponding busbar among the busbars of the voltage leveldefault String
getName()
Return the name of this extension.int
getSectionIndex()
Return the index of the busbar section within the corresponding busbarBusbarSectionPosition
setBusbarIndex(int busbarIndex)
BusbarSectionPosition
setSectionIndex(int sectionIndex)
-
Methods inherited from interface com.powsybl.commons.extensions.Extension
getExtendable, setExtendable
-
-
-
-
Field Detail
-
NAME
static final String NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
default String 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
BusbarSectionPosition setBusbarIndex(int busbarIndex)
-
getSectionIndex
int getSectionIndex()
Return the index of the busbar section within the corresponding busbar
-
setSectionIndex
BusbarSectionPosition setSectionIndex(int sectionIndex)
-
-