Package com.powsybl.iidm.network.impl

Interface MultiVariantObject

All Known Implementing Classes:

AbstractMultiVariantConnectableExtension, AbstractMultiVariantIdentifiableExtension, ActivePowerControlImpl, BatteryImpl, CoordinatedReactiveControlImpl, HvdcAngleDroopActivePowerControlImpl, HvdcOperatorActivePowerRangeImpl, LoadDetailImpl, NetworkImpl, RemoteReactivePowerControlImpl, SlackTerminalImpl, StandbyAutomatonImpl, SubnetworkImpl, VoltageRegulationImpl

public interface MultiVariantObject

An interface implemented by network objects that have attributes depending on the variant.

A class implementing this interface internally manages an array of variants and is notified when the array need to be resized thanks to extendVariantArraySize and reduceVariantArraySize callbacks.

Author:

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

Method Summary

Modifier and Type	Method	Description
void	allocateVariantArrayElement(int[] indexes, int sourceIndex)	Called to allocate a variant array element.
void	deleteVariantArrayElement(int index)	Called to delete a variant array element.
void	extendVariantArraySize(int initVariantArraySize, int number, int sourceIndex)	Called to extend the variant array.
void	reduceVariantArraySize(int number)	Called to reduce the variant array.

Method Details

extendVariantArraySize

void extendVariantArraySize(int initVariantArraySize,
 int number,
 int sourceIndex)

Called to extend the variant array.

Parameters:

initVariantArraySize - initial variant array size

number - number of element to add

sourceIndex - the variant index to use to initialize new variants

reduceVariantArraySize

void reduceVariantArraySize(int number)

Called to reduce the variant array.

Parameters:

number - number of element to remove

deleteVariantArrayElement

void deleteVariantArrayElement(int index)

Called to delete a variant array element.

Parameters:

index - the index of the variant array to delete

allocateVariantArrayElement

void allocateVariantArrayElement(int[] indexes,
 int sourceIndex)

Called to allocate a variant array element. All new variants will be initialize using values of the variant sourceIndex.

Parameters:

indexes - the indexes of the variant array to allocate

sourceIndex - the variant index to use to initialize new variants