Package com.powsybl.iidm.network
Interface Generator
- All Superinterfaces:
Connectable<Generator>
,Extendable<Generator>
,Identifiable<Generator>
,Injection<Generator>
,ReactiveLimitsHolder
A power generator.
Characteristics
Attribute | Type | Unit | Required | Defaut value | Description |
---|---|---|---|---|---|
Id | String | - | yes | - | Unique identifier of the generator |
Name | String | - | yes | - | Human-readable name of the generator |
EnergySource | EnergySource | - | yes | OTHER | The energy source type |
MinP | double | MW | yes | - | The minimum active power |
MaxP | double | MW | yes | - | The maximum active power |
RegulatingTerminal | Terminal | - | no | The generator's terminal | The terminal used for regulation |
VoltageRegulatorOn | boolean | - | no | false | The voltage regulating status |
TargetP | double | MW | yes | - | The active power target |
TargetQ | double | MVar | yes | only if `VoltageRegulatorOn` is set to false | The reactive power target |
TargetV | double | kV | yes | only if `VoltageRegulatorOn` is set to true | The voltage target |
RatedS | double | MVA | yes | - | The rated nominal power |
ReactiveLimits | - | - | no | min/max | Operational limits of the generator (P/Q/U diagram) |
To create a generator, see GeneratorAdder
- Author:
- Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionGet the energy source.double
getMaxP()
Get the maximal active power in MW.double
getMinP()
Get the minimal active power in MW.double
Get the rated nominal power (apparent power rating) in MVA.Get the terminal used for regulation.double
Get the active power target in MW.double
Get the reactive power target in MVAR.double
Get the voltage target in kV.default IdentifiableType
getType()
Get identifiable type.boolean
Get the voltage regulator status.setEnergySource
(EnergySource energySource) setMaxP
(double maxP) Set the maximal active power in MW.setMinP
(double minP) Set the minimal active power in MW.setRatedS
(double ratedS) setRegulatingTerminal
(Terminal regulatingTerminal) setTargetP
(double targetP) Set the active power target in MW.setTargetQ
(double targetQ) Set the reactive power target in MVAR.setTargetV
(double targetV) Set the voltage target in kV.setVoltageRegulatorOn
(boolean voltageRegulatorOn) Set the voltage regulator status.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
Methods inherited from interface com.powsybl.iidm.network.ReactiveLimitsHolder
getReactiveLimits, getReactiveLimits, newMinMaxReactiveLimits, newReactiveCapabilityCurve
-
Method Details
-
getEnergySource
EnergySource getEnergySource()Get the energy source. -
setEnergySource
-
getMaxP
double getMaxP()Get the maximal active power in MW. -
setMaxP
Set the maximal active power in MW. -
getMinP
double getMinP()Get the minimal active power in MW. -
setMinP
Set the minimal active power in MW. -
isVoltageRegulatorOn
boolean isVoltageRegulatorOn()Get the voltage regulator status.Depends on the working variant.
- See Also:
-
setVoltageRegulatorOn
Set the voltage regulator status.Depends on the working variant.
- See Also:
-
getRegulatingTerminal
Terminal getRegulatingTerminal()Get the terminal used for regulation.- Returns:
- the terminal used for regulation
-
setRegulatingTerminal
-
getTargetV
double getTargetV()Get the voltage target in kV.Depends on the working variant.
- See Also:
-
setTargetV
Set the voltage target in kV.Depends on the working variant.
- See Also:
-
getTargetP
double getTargetP()Get the active power target in MW.Depends on the working variant.
- See Also:
-
setTargetP
Set the active power target in MW.Depends on the working variant.
- See Also:
-
getTargetQ
double getTargetQ()Get the reactive power target in MVAR.Depends on the working variant.
- See Also:
-
setTargetQ
Set the reactive power target in MVAR.Depends on the working variant.
- See Also:
-
getRatedS
double getRatedS()Get the rated nominal power (apparent power rating) in MVA.- Returns:
- the rated nominal power in MVA or NaN if not defined
-
setRatedS
-
getType
Description copied from interface:Identifiable
Get identifiable type.- Specified by:
getType
in interfaceIdentifiable<Generator>
- Returns:
- the identifiable type
-