public interface ShuntCompensator extends Injection<ShuntCompensator>
ShuntCompensatorAdder
ShuntCompensatorAdder
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.
|
default double |
getMaximumB()
Deprecated.
Use
getbPerSection() * getMaximumSectionCount() instead. |
int |
getMaximumSectionCount()
Get the maximum section count.
|
default Terminal |
getRegulatingTerminal()
Get the terminal used for regulation.
|
default double |
getTargetDeadband()
Get the shunt compensator's deadband (in kV) used to avoid excessive update of discrete control while regulating.
|
default double |
getTargetV()
Get the shunt compensator's voltage target in kV if it exists.
|
default boolean |
isVoltageRegulatorOn()
Get the shunt compensator's regulating status.
|
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.
|
default ShuntCompensator |
setRegulatingTerminal(Terminal regulatingTerminal)
Set the terminal used for regulation.
|
default ShuntCompensator |
setTargetDeadband(double targetDeadband)
Set the shunt compensator's deadband (in kV) used to avoid excessive update of discrete control while regulating.
|
default ShuntCompensator |
setTargetV(double targetV)
Set the shunt compensator's voltage target in kV.
|
default ShuntCompensator |
setVoltageRegulatorOn(boolean voltageRegulatorOn)
Set the shunt compensator's regulating status.
|
getTerminal
getTerminals, getType, remove
getId, getName, getNameOrId, getNetwork, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasProperty, hasProperty, isFictitious, setFictitious, setProperty
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension
int getMaximumSectionCount()
ShuntCompensator setMaximumSectionCount(int maximumSectionCount)
maximumSectionCount
- the maximum number of sectionint getCurrentSectionCount()
It is expected to be greater than one and lesser than or equal to the maximum section count.
Depends on the working variant.
VariantManager
ShuntCompensator setCurrentSectionCount(int currentSectionCount)
Depends on the working variant.
currentSectionCount
- the number of sectionVariantManager
double getbPerSection()
ShuntCompensator setbPerSection(double bPerSection)
bPerSection
- the susceptance per section@Deprecated default double getMaximumB()
getbPerSection()
* getMaximumSectionCount()
instead.double getCurrentB()
Depends on the working variant.
VariantManager
default Terminal getRegulatingTerminal()
default ShuntCompensator setRegulatingTerminal(Terminal regulatingTerminal)
default boolean isVoltageRegulatorOn()
Depends on the working variant.
VariantManager
default ShuntCompensator setVoltageRegulatorOn(boolean voltageRegulatorOn)
Depends on the working variant.
VariantManager
default double getTargetV()
Depends on the working variant.
VariantManager
default ShuntCompensator setTargetV(double targetV)
Depends on the working variant.
VariantManager
default double getTargetDeadband()
Depends on the working variant.
VariantManager
default ShuntCompensator setTargetDeadband(double targetDeadband)
Depends on the working variant.
VariantManager
Copyright © 2020. All rights reserved.