com.powsybl.iidm.network

Interface Generator

All Superinterfaces:

Connectable<Generator>, Extendable<Generator>, Identifiable<Generator>, Injection<Generator>, ReactiveLimitsHolder

public interface Generator
extends Injection<Generator>, ReactiveLimitsHolder

A power generator.

To create a generator, see GeneratorAdder

See Also:

GeneratorAdder, MinMaxReactiveLimits, ReactiveCapabilityCurve

Method Summary

Modifier and Type	Method and Description
EnergySource	getEnergySource() Get the energy source.
double	getMaxP() Get the maximal active power in MW.
double	getMinP() Get the minimal active power in MW.
double	getRatedS() Get the rated nominal power in MVA.
Terminal	getRegulatingTerminal() Get the terminal used for regulation.
double	getTargetP() Get the active power target in MW.
double	getTargetQ() Get the reactive power target in MVAR.
double	getTargetV() Get the voltage target in kV.
boolean	isVoltageRegulatorOn() Get the voltage regulator status.
Generator	setEnergySource(EnergySource energySource)
Generator	setMaxP(double maxP) Set the maximal active power in MW.
Generator	setMinP(double minP) Set the minimal active power in MW.
Generator	setRatedS(double ratedS)
Generator	setRegulatingTerminal(Terminal regulatingTerminal)
Generator	setTargetP(double targetP) Set the active power target in MW.
Generator	setTargetQ(double targetQ) Set the reactive power target in MVAR.
Generator	setTargetV(double targetV) Set the voltage target in kV.
Generator	setVoltageRegulatorOn(boolean voltageRegulatorOn) Set the voltage regulator status.

Methods inherited from interface com.powsybl.iidm.network.Injection

getTerminal

Methods inherited from interface com.powsybl.iidm.network.Connectable

getTerminals, getType, remove

Methods inherited from interface com.powsybl.iidm.network.Identifiable

getId, getName, getProperties, hasProperty

Methods inherited from interface com.powsybl.commons.extensions.Extendable

addExtension, getExtension, getExtensionByName, getExtensions, removeExtension

Methods inherited from interface com.powsybl.iidm.network.ReactiveLimitsHolder

getReactiveLimits, getReactiveLimits, newMinMaxReactiveLimits, newReactiveCapabilityCurve

Method Detail

getEnergySource

EnergySource getEnergySource()

Get the energy source.

setEnergySource

Generator setEnergySource(EnergySource energySource)

getMaxP

double getMaxP()

Get the maximal active power in MW.

setMaxP

Generator setMaxP(double maxP)

Set the maximal active power in MW.

getMinP

double getMinP()

Get the minimal active power in MW.

setMinP

Generator setMinP(double minP)

Set the minimal active power in MW.

isVoltageRegulatorOn

boolean isVoltageRegulatorOn()

Get the voltage regulator status.

Depends on the working variant.

See Also:

VariantManager

setVoltageRegulatorOn

Generator setVoltageRegulatorOn(boolean voltageRegulatorOn)

Set the voltage regulator status.

Depends on the working variant.

See Also:

VariantManager

getRegulatingTerminal

Terminal getRegulatingTerminal()

Get the terminal used for regulation.

Returns:

the terminal used for regulation

setRegulatingTerminal

Generator setRegulatingTerminal(Terminal regulatingTerminal)

getTargetV

double getTargetV()

Get the voltage target in kV.

Depends on the working variant.

See Also:

VariantManager

setTargetV

Generator setTargetV(double targetV)

Set the voltage target in kV.

Depends on the working variant.

See Also:

VariantManager

getTargetP

double getTargetP()

Get the active power target in MW.

Depends on the working variant.

See Also:

VariantManager

setTargetP

Generator setTargetP(double targetP)

Set the active power target in MW.

Depends on the working variant.

See Also:

VariantManager

getTargetQ

double getTargetQ()

Get the reactive power target in MVAR.

Depends on the working variant.

See Also:

VariantManager

setTargetQ

Generator setTargetQ(double targetQ)

Set the reactive power target in MVAR.

Depends on the working variant.

See Also:

VariantManager

getRatedS

double getRatedS()

Get the rated nominal power in MVA.

Returns:

the rated nominal power in MVA or NaN if not defined

setRatedS

Generator setRatedS(double ratedS)