Package com.powsybl.iidm.mergingview
Class PhaseTapChangerAdapter
- java.lang.Object
-
- com.powsybl.iidm.mergingview.PhaseTapChangerAdapter
-
- All Implemented Interfaces:
PhaseTapChanger
,TapChanger<PhaseTapChanger,PhaseTapChangerStep>
public class PhaseTapChangerAdapter extends Object implements PhaseTapChanger
- Author:
- Thomas Adam
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.powsybl.iidm.network.PhaseTapChanger
PhaseTapChanger.RegulationMode
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OptionalInt
findTapPosition()
Get an optional containing the current tap position if it is defined.S
getCurrentStep()
Get the current step.protected I
getDelegate()
int
getHighTapPosition()
Get the highest tap position corresponding to the last step of the tap changer.protected com.powsybl.iidm.mergingview.MergingViewIndex
getIndex()
int
getLowTapPosition()
Get the lowest tap position corresponding to the first step of the tap changer.PhaseTapChanger.RegulationMode
getRegulationMode()
Get the regulation mode.Terminal
getRegulationTerminal()
Get the terminal used for regulation.double
getRegulationValue()
Get the regulation valueS
getStep(int tapPosition)
Get a step.int
getStepCount()
Get the number of steps.int
getTapPosition()
Get the current tap position.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.P
setLowTapPosition(int lowTapPosition)
Set the lowest tap position corresponding to the first step of the tap changer.P
setRegulating(boolean regulating)
Set the regulating status.PhaseTapChanger
setRegulationMode(PhaseTapChanger.RegulationMode regulationMode)
Set the regulation modeP
setRegulationTerminal(Terminal regulationTerminal)
Set the terminal used for regulation.PhaseTapChanger
setRegulationValue(double regulationValue)
Set the regulation value.P
setTapPosition(int tapPosition)
Set the current tap position.P
setTargetDeadband(double targetDeadband)
Set the tap changer's deadband (in kV) used to avoid excessive update of discrete control while regulating.P
unsetTapPosition()
Unset the current tap position: tap position is now undefined.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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, unsetTapPosition
-
-
-
-
Method Detail
-
getRegulationMode
public PhaseTapChanger.RegulationMode getRegulationMode()
Description copied from interface:PhaseTapChanger
Get the regulation mode.- Specified by:
getRegulationMode
in interfacePhaseTapChanger
- Returns:
- the regulation mode
-
setRegulationMode
public PhaseTapChanger setRegulationMode(PhaseTapChanger.RegulationMode regulationMode)
Description copied from interface:PhaseTapChanger
Set the regulation mode- Specified by:
setRegulationMode
in interfacePhaseTapChanger
- Parameters:
regulationMode
- the regulation mode- Returns:
- itself for method chaining
-
getRegulationValue
public double getRegulationValue()
Description copied from interface:PhaseTapChanger
Get the regulation value. - a threshold in A in case of current limiter regulation - a setpoint in MW in case of active power control regulationDepends on the working variant.
- Specified by:
getRegulationValue
in interfacePhaseTapChanger
- See Also:
VariantManager
-
setRegulationValue
public PhaseTapChanger setRegulationValue(double regulationValue)
Description copied from interface:PhaseTapChanger
Set the regulation value.Depends on the working variant.
- Specified by:
setRegulationValue
in interfacePhaseTapChanger
- See Also:
VariantManager
-
getRegulationTerminal
public Terminal getRegulationTerminal()
Description copied from interface:TapChanger
Get the terminal used for regulation.- Specified by:
getRegulationTerminal
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
-
setRegulationTerminal
public P setRegulationTerminal(Terminal regulationTerminal)
Description copied from interface:TapChanger
Set the terminal used for regulation.- Specified by:
setRegulationTerminal
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
-
getLowTapPosition
public int getLowTapPosition()
Description copied from interface:TapChanger
Get the lowest tap position corresponding to the first step of the tap changer.- Specified by:
getLowTapPosition
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
-
setLowTapPosition
public P setLowTapPosition(int lowTapPosition)
Description copied from interface:TapChanger
Set the lowest tap position corresponding to the first step of the tap changer.- Specified by:
setLowTapPosition
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
-
getHighTapPosition
public int getHighTapPosition()
Description copied from interface:TapChanger
Get the highest tap position corresponding to the last step of the tap changer.- Specified by:
getHighTapPosition
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
-
getTapPosition
public int getTapPosition()
Description copied from interface:TapChanger
Get the current tap position.Depends on the working variant.
- Specified by:
getTapPosition
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
- See Also:
VariantManager
-
findTapPosition
public OptionalInt findTapPosition()
Description copied from interface:TapChanger
Get an optional containing the current tap position if it is defined. Otherwise, get an empty optional.Depends on the working variant.
- Specified by:
findTapPosition
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
- See Also:
VariantManager
-
setTapPosition
public P setTapPosition(int tapPosition)
Description copied from interface:TapChanger
Set the current tap position.It is expected to be contained between the lowest and the highest tap position.
Depends on the working variant.
- Specified by:
setTapPosition
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
- Parameters:
tapPosition
- the current tap position- See Also:
VariantManager
-
unsetTapPosition
public P unsetTapPosition()
Description copied from interface:TapChanger
Unset the current tap position: tap position is now undefined. Note: this can be done only in SCADA validation level.- Specified by:
unsetTapPosition
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
-
getStepCount
public int getStepCount()
Description copied from interface:TapChanger
Get the number of steps.- Specified by:
getStepCount
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
-
getStep
public S getStep(int tapPosition)
Description copied from interface:TapChanger
Get a step.- Specified by:
getStep
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
- Parameters:
tapPosition
- position of the tap- Returns:
- the step
-
getCurrentStep
public S getCurrentStep()
Description copied from interface:TapChanger
Get the current step.Depends on the working variant.
- Specified by:
getCurrentStep
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
- See Also:
VariantManager
-
isRegulating
public boolean isRegulating()
Description copied from interface:TapChanger
Get the regulating status.Depends on the working variant.
- Specified by:
isRegulating
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
- See Also:
VariantManager
-
setRegulating
public P setRegulating(boolean regulating)
Description copied from interface:TapChanger
Set the regulating status.Depends on the working variant.
- Specified by:
setRegulating
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
- See Also:
VariantManager
-
getTargetDeadband
public double getTargetDeadband()
Description copied from interface:TapChanger
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.
- Specified by:
getTargetDeadband
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
- See Also:
VariantManager
-
setTargetDeadband
public P setTargetDeadband(double targetDeadband)
Description copied from interface:TapChanger
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.
- Specified by:
setTargetDeadband
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
- See Also:
VariantManager
-
remove
public void remove()
Description copied from interface:TapChanger
Remove the tap changer.- Specified by:
remove
in interfaceTapChanger<P extends TapChanger<P,S>,S extends TapChangerStep<S>>
-
getDelegate
protected I getDelegate()
-
getIndex
protected com.powsybl.iidm.mergingview.MergingViewIndex getIndex()
-
-