com.powsybl.iidm.network

Interface TapChanger<C extends TapChanger<C,S>,S extends TapChangerStep<S>>

All Known Subinterfaces:

PhaseTapChanger, RatioTapChanger

All Known Implementing Classes:

PhaseTapChangerAdapter, RatioTapChangerAdapter

public interface TapChanger<C extends TapChanger<C,S>,S extends TapChangerStep<S>>

Author:

Geoffroy Jamgotchian

Method Summary

Modifier and Type	Method and Description
S	getCurrentStep() Get the current step.
int	getHighTapPosition() Get the highest tap position corresponding to the last step of the tap changer.
int	getLowTapPosition() Get the lowest tap position corresponding to the first step of the tap changer.
Terminal	getRegulationTerminal() Get the terminal used for regulation.
S	getStep(int tapPosition) Get a step.
int	getStepCount() Get the number of steps.
int	getTapPosition() Get the current tap position.
default double	getTargetDeadband() Get the tap changer's deadband (in kV) used to avoid excessive update of discrete control while regulating.
boolean	isRegulating() Get the regulating status.
void	remove() Remove the tap changer.
C	setLowTapPosition(int lowTapPosition) Set the lowest tap position corresponding to the first step of the tap changer.
C	setRegulating(boolean regulating) Set the regulating status.
C	setRegulationTerminal(Terminal regulationTerminal) Set the terminal used for regulation.
C	setTapPosition(int tapPosition) Set the current tap position.
default C	setTargetDeadband(double targetDeadband) Set the tap changer's deadband (in kV) used to avoid excessive update of discrete control while regulating.

Method Detail

getLowTapPosition

int getLowTapPosition()

Get the lowest tap position corresponding to the first step of the tap changer.

setLowTapPosition

C setLowTapPosition(int lowTapPosition)

Set the lowest tap position corresponding to the first step of the tap changer.

getHighTapPosition

int getHighTapPosition()

Get the highest tap position corresponding to the last step of the tap changer.

getTapPosition

int getTapPosition()

Get the current tap position.

Depends on the working variant.

See Also:

VariantManager

setTapPosition

C setTapPosition(int tapPosition)

Set the current tap position.

It is expected to be contained between the lowest and the highest tap position.

Depends on the working variant.

Parameters:

tapPosition - the current tap position

See Also:

VariantManager

getStepCount

int getStepCount()

Get the number of steps.

getStep

S getStep(int tapPosition)

Get a step.

Parameters:

tapPosition - position of the tap

Returns:

the step

getCurrentStep

S getCurrentStep()

Get the current step.

Depends on the working variant.

See Also:

VariantManager

isRegulating

boolean isRegulating()

Get the regulating status.

Depends on the working variant.

See Also:

VariantManager

setRegulating

C setRegulating(boolean regulating)

Set the regulating status.

Depends on the working variant.

See Also:

VariantManager

getRegulationTerminal

Terminal getRegulationTerminal()

Get the terminal used for regulation.

setRegulationTerminal

C setRegulationTerminal(Terminal regulationTerminal)

Set the terminal used for regulation.

getTargetDeadband

default double getTargetDeadband()

Get the tap changer's deadband (in kV) used to avoid excessive update of discrete control while regulating. This attribute is necessary only if the tap changer is regulating.

Depends on the working variant.

See Also:

VariantManager

setTargetDeadband

default C setTargetDeadband(double targetDeadband)

Set the tap changer's deadband (in kV) used to avoid excessive update of discrete control while regulating. This attribute is necessary only if the tap changer is regulating. It must be positive.

Depends on the working variant.

See Also:

VariantManager

remove

void remove()

Remove the tap changer.