Interface StaticVarCompensator
- All Superinterfaces:
Connectable<StaticVarCompensator>
,Extendable<StaticVarCompensator>
,Identifiable<StaticVarCompensator>
,Injection<StaticVarCompensator>
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 <geoffroy.jamgotchian at rte-france.com>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptiondouble
getBmax()
Get the maximum susceptance in S.double
getBmin()
Get the minimum susceptance in S.double
Get the reactive power setpoint in MVAR.default Terminal
Get the terminal used for regulation.Get the regulating mode.default IdentifiableType
getType()
Get identifiable type.double
Get the voltage setpoint in Kv.setBmax
(double bMax) Set the maximum susceptance in S.setBmin
(double bMin) Set the minimum susceptance in S.setReactivePowerSetpoint
(double reactivePowerSetpoint) Set the reactive power setpoint in MVAR.default StaticVarCompensator
setRegulatingTerminal
(Terminal regulatingTerminal) Set the terminal used for regulation.setRegulationMode
(StaticVarCompensator.RegulationMode regulationMode) set the regulating mode.setVoltageSetpoint
(double voltageSetpoint) Set the voltage setpoint in Kv.Methods inherited from interface com.powsybl.iidm.network.Connectable
connect, connect, disconnect, disconnect, 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, getNameOrId, getNetwork, getOptionalName, getParentNetwork, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, removeProperty, setFictitious, setName, setProperty
Methods inherited from interface com.powsybl.iidm.network.Injection
getTerminal
-
Method Details
-
getBmin
double getBmin()Get the minimum susceptance in S.- Returns:
- the minimum susceptance
-
setBmin
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
Set the maximum susceptance in S.- Parameters:
bMax
- the maximum susceptance- Returns:
- this to allow method chaining
-
getVoltageSetpoint
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
-
setVoltageSetpoint
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
-
getReactivePowerSetpoint
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
-
setReactivePowerSetpoint
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
-
getRegulationMode
StaticVarCompensator.RegulationMode getRegulationMode()Get the regulating mode.
Depends on the working variant.
- Returns:
- the regulating mode
-
setRegulationMode
set the regulating mode.
Depends on the working variant.
- Parameters:
regulationMode
- the regulating mode- Returns:
- this to allow method chaining
-
getRegulatingTerminal
Get the terminal used for regulation.
- Returns:
- the terminal used for regulation
-
setRegulatingTerminal
Set the terminal used for regulation.
- Returns:
- this to allow method chaining
-
getType
Description copied from interface:Identifiable
Get identifiable type.- Specified by:
getType
in interfaceIdentifiable<StaticVarCompensator>
- Returns:
- the identifiable type
-