com.powsybl.iidm.network

Interface ShuntCompensator

All Superinterfaces:

Connectable<ShuntCompensator>, Extendable<ShuntCompensator>, Identifiable<ShuntCompensator>, Injection<ShuntCompensator>

public interface ShuntCompensator
extends Injection<ShuntCompensator>

A shunt compensator. To create a shunt compensator, see ShuntCompensatorAdder

See Also:

ShuntCompensatorAdder

Method Summary

Modifier and Type	Method and Description
double	getbPerSection() Get the susceptance per section in S.
double	getCurrentB() Get the susceptance for the current section counts.
int	getCurrentSectionCount() Get the current section count.
double	getMaximumB() Get the susceptance for the maximum section count.
int	getMaximumSectionCount() Get the maximum section count.
ShuntCompensator	setbPerSection(double bPerSection) Set the susceptance per section in S.
ShuntCompensator	setCurrentSectionCount(int currentSectionCount) Change the number of section.
ShuntCompensator	setMaximumSectionCount(int maximumSectionCount) Set the maximum number of section.

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

Method Detail

getMaximumSectionCount

int getMaximumSectionCount()

Get the maximum section count.

setMaximumSectionCount

ShuntCompensator setMaximumSectionCount(int maximumSectionCount)

Set the maximum number of section.

Parameters:

maximumSectionCount - the maximum number of section

Returns:

the shunt compensator to chain method calls.

getCurrentSectionCount

int getCurrentSectionCount()

Get the current section count.

It is expected to be greater than one and lesser than or equal to the maximum section count.

Depends on the working variant.

See Also:

VariantManager

setCurrentSectionCount

ShuntCompensator setCurrentSectionCount(int currentSectionCount)

Change the number of section.

Depends on the working variant.

Parameters:

currentSectionCount - the number of section

Returns:

the shunt compensator to chain method calls.

See Also:

VariantManager

getbPerSection

double getbPerSection()

Get the susceptance per section in S.

setbPerSection

ShuntCompensator setbPerSection(double bPerSection)

Set the susceptance per section in S.

Parameters:

bPerSection - the susceptance per section

Returns:

the shunt compensator to chain method calls.

getMaximumB

double getMaximumB()

Get the susceptance for the maximum section count.

getCurrentB

double getCurrentB()

Get the susceptance for the current section counts.

Depends on the working variant.

See Also:

VariantManager