Package com.powsybl.iidm.network
Interface VscConverterStation
- All Superinterfaces:
Connectable<VscConverterStation>
,Extendable<VscConverterStation>
,HvdcConverterStation<VscConverterStation>
,Identifiable<VscConverterStation>
,Injection<VscConverterStation>
,ReactiveLimitsHolder
public interface VscConverterStation
extends HvdcConverterStation<VscConverterStation>, ReactiveLimitsHolder
VSC converter station.
Characteristics
Attribute | Type | Unit | Required | Defaut value | Description |
---|---|---|---|---|---|
Id | String | - | yes | - | Unique identifier of the VSC converter station |
Name | String | - | yes | - | Human-readable name of the VSC converter station |
VoltageRegulatorOn | boolean | - | yes | - | The voltage regulator status |
VoltageSetpoint | double | kV | only if VoltageRegulatorOn is set to true | - | The voltage setpoint |
ReactivePowerSetpoint | double | MVar | only if VoltageRegulatorOn is set to false | - | The reactive power setpoint |
- Author:
- Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>, Mathieu Bague <mathieu.bague at rte-france.com>
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.powsybl.iidm.network.HvdcConverterStation
HvdcConverterStation.HvdcType
-
Method Summary
Modifier and TypeMethodDescriptiondouble
Get the reactive power setpoint (MVar).default Terminal
Get the terminal used for regulation.double
Get the voltage setpoint (Kv).boolean
Check if voltage regulator is on.setReactivePowerSetpoint
(double reactivePowerSetpoint) Set the reactive power setpoint (MVar).default VscConverterStation
setRegulatingTerminal
(Terminal regulatingTerminal) setVoltageRegulatorOn
(boolean voltageRegulatorOn) Set voltage regulator status.setVoltageSetpoint
(double voltageSetpoint) Set the voltage setpoint (Kv).Methods inherited from interface com.powsybl.iidm.network.Connectable
connect, connect, connect, disconnect, 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.HvdcConverterStation
getHvdcLine, getHvdcType, getLossFactor, getOtherConverterStation, getType, setLossFactor
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
Methods inherited from interface com.powsybl.iidm.network.ReactiveLimitsHolder
getReactiveLimits, getReactiveLimits, newMinMaxReactiveLimits, newReactiveCapabilityCurve
-
Method Details
-
isVoltageRegulatorOn
boolean isVoltageRegulatorOn()Check if voltage regulator is on.- Returns:
- true if voltage regulator is on, false otherwise
-
setVoltageRegulatorOn
Set voltage regulator status.- Parameters:
voltageRegulatorOn
- the new voltage regulator status- Returns:
- the converter itself to allow method chaining
-
getVoltageSetpoint
double getVoltageSetpoint()Get the voltage setpoint (Kv).- Returns:
- the voltage setpoint
-
setVoltageSetpoint
Set the voltage setpoint (Kv).- Parameters:
voltageSetpoint
- the voltage setpoint- Returns:
- the converter itself to allow method chaining
-
getReactivePowerSetpoint
double getReactivePowerSetpoint()Get the reactive power setpoint (MVar).- Returns:
- the reactive power setpoint
-
setReactivePowerSetpoint
Set the reactive power setpoint (MVar).- Parameters:
reactivePowerSetpoint
- the reactive power setpoint- Returns:
- the converter itself to allow method chaining
-
getRegulatingTerminal
Get the terminal used for regulation.- Returns:
- the terminal used for regulation
-
setRegulatingTerminal
-