Package com.powsybl.sld.layout

Interface VoltageLevelLayoutFactorySmartSelector

All Known Implementing Classes:

CgmesVoltageLevelLayoutFactorySmartSelector, PositionByClusterVoltageLevelLayoutFactorySmartSelector, PositionFromExtensionVoltageLevelLayoutFactorySmartSelector

public interface VoltageLevelLayoutFactorySmartSelector

VoltageLevelLayoutFactory smart selector.

Author:

Geoffroy Jamgotchian

Method Summary

Modifier and Type	Method	Description
VoltageLevelLayoutFactory	createFactory(com.powsybl.iidm.network.Network network)	Create a VoltageLevelLayoutFactory instance.
static Optional<VoltageLevelLayoutFactorySmartSelector>	findBest(com.powsybl.iidm.network.VoltageLevel vl)	Find best VoltageLevelLayoutFactory, i.e the one with higher priority among selectable ones.
int	getPriority(com.powsybl.iidm.network.VoltageLevel vl)	Get a selection priority number.
boolean	isSelectable(com.powsybl.iidm.network.VoltageLevel vl)	Verify that the VoltageLevelLayoutFactory is selectable for this voltage level.

Method Detail

findBest

static Optional<VoltageLevelLayoutFactorySmartSelector> findBest(com.powsybl.iidm.network.VoltageLevel vl)

Find best VoltageLevelLayoutFactory, i.e the one with higher priority among selectable ones.

Parameters:

vl - the voltage level

Returns:

best VoltageLevelLayoutFactory

getPriority

int getPriority(com.powsybl.iidm.network.VoltageLevel vl)

Get a selection priority number. A high number means a high priority.

Parameters:

vl - the voltage level

Returns:

priority number

isSelectable

boolean isSelectable(com.powsybl.iidm.network.VoltageLevel vl)

Verify that the VoltageLevelLayoutFactory is selectable for this voltage level.

Parameters:

vl - the voltage level

Returns:

true if the VoltageLevelLayoutFactory is selectable for this voltage level, false otherwise.

createFactory

VoltageLevelLayoutFactory createFactory(com.powsybl.iidm.network.Network network)

Create a VoltageLevelLayoutFactory instance.

Returns:

a VoltageLevelLayoutFactory instance