Package com.powsybl.iidm.network
Interface TapChanger<C extends TapChanger<C,S,R,A>,S extends TapChangerStep<S>,R extends TapChangerStepsReplacer<R,A>,A extends TapChangerStepAdder<A,R>>
- All Known Subinterfaces:
PhaseTapChanger
,RatioTapChanger
public interface TapChanger<C extends TapChanger<C,S,R,A>,S extends TapChangerStep<S>,R extends TapChangerStepsReplacer<R,A>,A extends TapChangerStepAdder<A,R>>
- Author:
- Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
-
Method Summary
Modifier and TypeMethodDescriptiondefault OptionalInt
Get an optional containing the current tap position if it is defined.Get all Tap changer stepsGet the current step.int
Get the highest tap position corresponding to the last step of the tap changer.int
Get the lowest tap position corresponding to the first step of the tap changer.default OptionalInt
Get the position of the neutral step (rho = 1, alpha = 0) if it exists.Get the neutral step (rho = 1, alpha = 0) if it exists.Get the terminal used for regulation.getStep
(int tapPosition) Get a step.int
Get the number of steps.int
Get the current tap position.default double
Get the tap changer's deadband (in kV) used to avoid excessive update of discrete control while regulating.boolean
Get the regulating status.void
remove()
Remove the tap changer.setLowTapPosition
(int lowTapPosition) Set the lowest tap position corresponding to the first step of the tap changer.setRegulating
(boolean regulating) Set the regulating status.setRegulationTerminal
(Terminal regulationTerminal) Set the terminal used for regulation.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.Return a replacer that allow to replace the whole step list.default C
Unset the current tap position: tap position is now undefined.
-
Method Details
-
getLowTapPosition
int getLowTapPosition()Get the lowest tap position corresponding to the first step of the tap changer. -
setLowTapPosition
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:
-
findTapPosition
Get an optional containing the current tap position if it is defined. Otherwise, get an empty optional.Depends on the working variant.
- See Also:
-
setTapPosition
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:
-
unsetTapPosition
Unset the current tap position: tap position is now undefined. Note: this can be done only in SCADA validation level. -
getStepCount
int getStepCount()Get the number of steps. -
getStep
Get a step.- Parameters:
tapPosition
- position of the tap- Returns:
- the step
-
stepsReplacer
R stepsReplacer()Return a replacer that allow to replace the whole step list. -
getCurrentStep
S getCurrentStep()Get the current step.Depends on the working variant.
- See Also:
-
getNeutralPosition
Get the position of the neutral step (rho = 1, alpha = 0) if it exists. Otherwise return an empty optional. -
getNeutralStep
Get the neutral step (rho = 1, alpha = 0) if it exists. Otherwise return an empty optional. -
isRegulating
boolean isRegulating()Get the regulating status.Depends on the working variant.
- See Also:
-
setRegulating
Set the regulating status.Depends on the working variant.
- See Also:
-
getRegulationTerminal
Terminal getRegulationTerminal()Get the terminal used for regulation. -
setRegulationTerminal
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:
-
setTargetDeadband
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:
-
remove
void remove()Remove the tap changer. -
getAllSteps
Get all Tap changer steps
-