Interface StaticVarCompensator
-
- All Superinterfaces:
Connectable<StaticVarCompensator>
,Extendable<StaticVarCompensator>
,Identifiable<StaticVarCompensator>
,Injection<StaticVarCompensator>
- All Known Implementing Classes:
StaticVarCompensatorAdapter
public interface StaticVarCompensator extends Injection<StaticVarCompensator>
Static VAR compensator model.Characteristics
Attribute Type Unit Required Defaut value Description Id String - yes - Unique identifier of the static VAR compensator Name String - yes - Human-readable name of the static VAR compensator Bmin double S yes - The minimum susceptance Bmax double S yes - The maximum susceptance VoltageSetPoint double kV only if RegulationMode is set to VOLTAGE - The voltage setpoint ReactivePowerSetpoint double MVar only if RegulationMode is set to REACTIVE_POWER - The reactive power setpoint RegulatingTerminal Terminal - no The static VAR compensator's terminal The terminal used for regulation RegulationMode RegulationMode - yes - The regulation mode - Author:
- Geoffroy Jamgotchian
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
StaticVarCompensator.RegulationMode
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description double
getBmax()
Get the maximum susceptance in S.double
getBmin()
Get the minimum susceptance in S.default double
getReactivePowerSetpoint()
Get the reactive power setpoint in MVAR.default double
getReactivePowerSetPoint()
Deprecated.usegetReactivePowerSetpoint()
instead.default Terminal
getRegulatingTerminal()
Get the terminal used for regulation.StaticVarCompensator.RegulationMode
getRegulationMode()
Get the regulating mode.default IdentifiableType
getType()
Get identifiable type.default double
getVoltageSetpoint()
Get the voltage setpoint in Kv.default double
getVoltageSetPoint()
Deprecated.usegetVoltageSetpoint()
instead.StaticVarCompensator
setBmax(double bMax)
Set the maximum susceptance in S.StaticVarCompensator
setBmin(double bMin)
Set the minimum susceptance in S.default StaticVarCompensator
setReactivePowerSetpoint(double reactivePowerSetpoint)
Set the reactive power setpoint in MVAR.default StaticVarCompensator
setReactivePowerSetPoint(double reactivePowerSetPoint)
Deprecated.default StaticVarCompensator
setRegulatingTerminal(Terminal regulatingTerminal)
Set the terminal used for regulation.StaticVarCompensator
setRegulationMode(StaticVarCompensator.RegulationMode regulationMode)
set the regulating mode.default StaticVarCompensator
setVoltageSetpoint(double voltageSetpoint)
Set the voltage setpoint in Kv.default StaticVarCompensator
setVoltageSetPoint(double voltageSetPoint)
Deprecated.usesetVoltageSetpoint(double voltageSetpoint)
instead.-
Methods inherited from interface com.powsybl.iidm.network.Connectable
getTerminals, remove
-
Methods inherited from interface com.powsybl.commons.extensions.Extendable
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension
-
Methods inherited from interface com.powsybl.iidm.network.Identifiable
addAlias, addAlias, addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getName, getNameOrId, getNetwork, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, removeProperty, setFictitious, setName, setProperty
-
Methods inherited from interface com.powsybl.iidm.network.Injection
getTerminal
-
-
-
-
Method Detail
-
getBmin
double getBmin()
Get the minimum susceptance in S.- Returns:
- the minimum susceptance
-
setBmin
StaticVarCompensator setBmin(double bMin)
Set the minimum susceptance in S.- Parameters:
bMin
- minimum susceptance- Returns:
- this to allow method chaining
-
getBmax
double getBmax()
Get the maximum susceptance in S.- Returns:
- the maximum susceptance
-
setBmax
StaticVarCompensator setBmax(double bMax)
Set the maximum susceptance in S.- Parameters:
bMax
- the maximum susceptance- Returns:
- this to allow method chaining
-
getVoltageSetpoint
default double getVoltageSetpoint()
Get the voltage setpoint in Kv.
Needed only when regulating mode is set to
StaticVarCompensator.RegulationMode.VOLTAGE
.Depends on the working variant.
- Returns:
- the voltage setpoint
-
getVoltageSetPoint
@Deprecated default double getVoltageSetPoint()
Deprecated.usegetVoltageSetpoint()
instead.
-
setVoltageSetpoint
default StaticVarCompensator setVoltageSetpoint(double voltageSetpoint)
Set the voltage setpoint in Kv.
Needed only when regulating mode is set to
StaticVarCompensator.RegulationMode.VOLTAGE
.Depends on the working variant.
- Parameters:
voltageSetpoint
- the voltage setpoint- Returns:
- this to allow method chaining
-
setVoltageSetPoint
@Deprecated default StaticVarCompensator setVoltageSetPoint(double voltageSetPoint)
Deprecated.usesetVoltageSetpoint(double voltageSetpoint)
instead.
-
getReactivePowerSetpoint
default double getReactivePowerSetpoint()
Get the reactive power setpoint in MVAR.
Needed only when regulating mode is set to
StaticVarCompensator.RegulationMode.REACTIVE_POWER
.Depends on the working variant.
- Returns:
- the reactive power setpoint
-
getReactivePowerSetPoint
@Deprecated default double getReactivePowerSetPoint()
Deprecated.usegetReactivePowerSetpoint()
instead.
-
setReactivePowerSetpoint
default StaticVarCompensator setReactivePowerSetpoint(double reactivePowerSetpoint)
Set the reactive power setpoint in MVAR.
Needed only when regulating mode is set to
StaticVarCompensator.RegulationMode.REACTIVE_POWER
.Depends on the working variant.
- Parameters:
reactivePowerSetpoint
- the reactive power setpoint- Returns:
- this to allow method chaining
-
setReactivePowerSetPoint
@Deprecated default StaticVarCompensator setReactivePowerSetPoint(double reactivePowerSetPoint)
Deprecated.
-
getRegulationMode
StaticVarCompensator.RegulationMode getRegulationMode()
Get the regulating mode.
Depends on the working variant.
- Returns:
- the regulating mode
-
setRegulationMode
StaticVarCompensator setRegulationMode(StaticVarCompensator.RegulationMode regulationMode)
set the regulating mode.
Depends on the working variant.
- Parameters:
regulationMode
- the regulating mode- Returns:
- this to allow method chaining
-
getRegulatingTerminal
default Terminal getRegulatingTerminal()
Get the terminal used for regulation.
- Returns:
- the terminal used for regulation
-
setRegulatingTerminal
default StaticVarCompensator setRegulatingTerminal(Terminal regulatingTerminal)
Set the terminal used for regulation.
- Returns:
- this to allow method chaining
-
getType
default IdentifiableType getType()
Description copied from interface:Identifiable
Get identifiable type.- Specified by:
getType
in interfaceIdentifiable<StaticVarCompensator>
- Returns:
- the identifiable type
-
-