Package com.powsybl.iidm.network

Interface RatioTapChanger

All Superinterfaces:

TapChanger<RatioTapChanger,RatioTapChangerStep,RatioTapChangerStepsReplacer,RatioTapChangerStepsReplacer.StepAdder>

public interface RatioTapChanger
extends TapChanger<RatioTapChanger,RatioTapChangerStep,RatioTapChangerStepsReplacer,RatioTapChangerStepsReplacer.StepAdder>

A ratio tap changer that is associated to a transformer to control the voltage or reactive power.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RatioTapChanger.RegulationMode

Method Summary

Modifier and Type	Method	Description
RatioTapChanger.RegulationMode	getRegulationMode()	Get the regulation mode.
double	getRegulationValue()	Get the regulation value
double	getTargetV()	Get the target voltage in kV.
boolean	hasLoadTapChangingCapabilities()	Get the load tap changing capabilities status.
RatioTapChanger	setLoadTapChangingCapabilities(boolean status)	Set the load tap changing capabilities status.
RatioTapChanger	setRegulationMode(RatioTapChanger.RegulationMode regulationMode)	Set the regulation mode.
RatioTapChanger	setRegulationValue(double regulationValue)	Set the regulation value.
RatioTapChanger	setTargetV(double targetV)	Set the target voltage in kV and sets regulating mode to RatioTapChanger.RegulationMode.VOLTAGE.

Methods inherited from interface com.powsybl.iidm.network.TapChanger

findTapPosition, getAllSteps, getCurrentStep, getHighTapPosition, getLowTapPosition, getNeutralPosition, getNeutralStep, getRegulationTerminal, getStep, getStepCount, getTapPosition, getTargetDeadband, isRegulating, remove, setLowTapPosition, setRegulating, setRegulationTerminal, setTapPosition, setTargetDeadband, stepsReplacer, unsetTapPosition

Method Details

getRegulationMode

RatioTapChanger.RegulationMode getRegulationMode()

Get the regulation mode. Supported modes are RatioTapChanger.RegulationMode.VOLTAGE and RatioTapChanger.RegulationMode.REACTIVE_POWER.

Returns:

the regulation mode.

setRegulationMode

RatioTapChanger setRegulationMode(RatioTapChanger.RegulationMode regulationMode)

Set the regulation mode. Supported modes are RatioTapChanger.RegulationMode.VOLTAGE and RatioTapChanger.RegulationMode.REACTIVE_POWER.

Parameters:

regulationMode - the regulation mode.

Returns:

itself for method chaining

getRegulationValue

double getRegulationValue()

Get the regulation value. - a setpoint in kV in case of RatioTapChanger.RegulationMode.VOLTAGE regulation - a setpoint in MVar in case of RatioTapChanger.RegulationMode.REACTIVE_POWER regulation

Depends on the working variant.

See Also:

• VariantManager

setRegulationValue

RatioTapChanger setRegulationValue(double regulationValue)

Set the regulation value.

Depends on the working variant.

Parameters:

regulationValue - the regulation value.

Returns:

itself for method chaining.

See Also:

• VariantManager

getTargetV

double getTargetV()

Get the target voltage in kV.

Returns NaN if the regulation mode is not RatioTapChanger.RegulationMode.VOLTAGE.

Depends on the working variant.

See Also:

• VariantManager

setTargetV

RatioTapChanger setTargetV(double targetV)

Set the target voltage in kV and sets regulating mode to RatioTapChanger.RegulationMode.VOLTAGE.

Depends on the working variant.

Returns:

itself for method chaining.

See Also:

• VariantManager

hasLoadTapChangingCapabilities

boolean hasLoadTapChangingCapabilities()

Get the load tap changing capabilities status.

setLoadTapChangingCapabilities

RatioTapChanger setLoadTapChangingCapabilities(boolean status)

Set the load tap changing capabilities status.

Returns:

itself for method chaining.