public class ShuntCompensatorAdapter extends Object implements ShuntCompensator
Modifier and Type | Method and Description |
---|---|
<E extends Extension<I>> |
addExtension(Class<? super E> type,
E extension)
Add en extension to this extendable object.
|
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.
|
protected I |
getDelegate() |
<E extends Extension<I>> |
getExtension(Class<? super E> type)
Get an extension based on its class type.
|
<E extends Extension<I>> |
getExtensionByName(String name)
Get an extension based on its name.
|
<E extends Extension<I>> |
getExtensions()
Get all extensions associated with this extendable object..
|
String |
getId()
Get the unique identifier of the object.
|
protected com.powsybl.iidm.mergingview.MergingViewIndex |
getIndex() |
int |
getMaximumSectionCount()
Get the maximum section count.
|
String |
getNameOrId()
Get the name of the object if it exists.
|
MergingView |
getNetwork()
Get the network associated to the object.
|
Optional<String> |
getOptionalName()
Return an optional containing the name of the object if it exists.
|
String |
getProperty(String key)
Get property associated to specified key.
|
String |
getProperty(String key,
String defaultValue)
Get property associated to specified key, with default value.
|
Set<String> |
getPropertyNames()
Get properties key values.
|
Terminal |
getRegulatingTerminal()
Get the terminal used for regulation.
|
double |
getTargetDeadband()
Get the shunt compensator's deadband (in kV) used to avoid excessive update of discrete control while regulating.
|
double |
getTargetV()
Get the shunt compensator's voltage target in kV if it exists.
|
Terminal |
getTerminal()
Get the terminal.
|
List<? extends Terminal> |
getTerminals() |
ConnectableType |
getType()
Get the connectable type.
|
boolean |
hasProperty()
Check that this object has some properties.
|
boolean |
hasProperty(String key)
Check that this object has property with specified name.
|
boolean |
isFictitious()
Get the fictitious status
|
boolean |
isVoltageRegulatorOn()
Get the shunt compensator's regulating status.
|
<E extends Extension<I>,B extends ExtensionAdder<I,E>> |
newExtension(Class<B> type)
Returns an extensionAdder to build and add an extension for this extendable.
|
void |
remove()
Remove the equipment.
|
<E extends Extension<I>> |
removeExtension(Class<E> type)
Remove an extension based on its class type.
|
ShuntCompensator |
setbPerSection(double bPerSection)
Set the susceptance per section in S.
|
ShuntCompensator |
setCurrentSectionCount(int currentSectionCount)
Change the number of section.
|
void |
setFictitious(boolean fictitious)
Set the fictitious status
|
ShuntCompensator |
setMaximumSectionCount(int maximumSectionCount)
Set the maximum number of section.
|
String |
setProperty(String key,
String value)
Set property value associated to specified key.
|
ShuntCompensator |
setRegulatingTerminal(Terminal regulatingTerminal)
Set the terminal used for regulation.
|
ShuntCompensator |
setTargetDeadband(double targetDeadband)
Set the shunt compensator's deadband (in kV) used to avoid excessive update of discrete control while regulating.
|
ShuntCompensator |
setTargetV(double targetV)
Set the shunt compensator's voltage target in kV.
|
ShuntCompensator |
setVoltageRegulatorOn(boolean voltageRegulatorOn)
Set the shunt compensator's regulating status.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMaximumB
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
public int getMaximumSectionCount()
ShuntCompensator
getMaximumSectionCount
in interface ShuntCompensator
public ShuntCompensator setMaximumSectionCount(int maximumSectionCount)
ShuntCompensator
setMaximumSectionCount
in interface ShuntCompensator
maximumSectionCount
- the maximum number of sectionpublic int getCurrentSectionCount()
ShuntCompensator
It is expected to be greater than one and lesser than or equal to the maximum section count.
Depends on the working variant.
getCurrentSectionCount
in interface ShuntCompensator
VariantManager
public ShuntCompensator setCurrentSectionCount(int currentSectionCount)
ShuntCompensator
Depends on the working variant.
setCurrentSectionCount
in interface ShuntCompensator
currentSectionCount
- the number of sectionVariantManager
public double getbPerSection()
ShuntCompensator
getbPerSection
in interface ShuntCompensator
public ShuntCompensator setbPerSection(double bPerSection)
ShuntCompensator
setbPerSection
in interface ShuntCompensator
bPerSection
- the susceptance per sectionpublic double getCurrentB()
ShuntCompensator
Depends on the working variant.
getCurrentB
in interface ShuntCompensator
VariantManager
public Terminal getRegulatingTerminal()
ShuntCompensator
getRegulatingTerminal
in interface ShuntCompensator
public ShuntCompensator setRegulatingTerminal(Terminal regulatingTerminal)
ShuntCompensator
setRegulatingTerminal
in interface ShuntCompensator
public boolean isVoltageRegulatorOn()
ShuntCompensator
Depends on the working variant.
isVoltageRegulatorOn
in interface ShuntCompensator
VariantManager
public ShuntCompensator setVoltageRegulatorOn(boolean voltageRegulatorOn)
ShuntCompensator
Depends on the working variant.
setVoltageRegulatorOn
in interface ShuntCompensator
VariantManager
public double getTargetV()
ShuntCompensator
Depends on the working variant.
getTargetV
in interface ShuntCompensator
VariantManager
public ShuntCompensator setTargetV(double targetV)
ShuntCompensator
Depends on the working variant.
setTargetV
in interface ShuntCompensator
VariantManager
public double getTargetDeadband()
ShuntCompensator
Depends on the working variant.
getTargetDeadband
in interface ShuntCompensator
VariantManager
public ShuntCompensator setTargetDeadband(double targetDeadband)
ShuntCompensator
Depends on the working variant.
setTargetDeadband
in interface ShuntCompensator
VariantManager
public Terminal getTerminal()
Injection
getTerminal
in interface Injection<I extends Injection<I>>
public List<? extends Terminal> getTerminals()
getTerminals
in interface Connectable<I extends Injection<I>>
public ConnectableType getType()
Connectable
getType
in interface Connectable<I extends Injection<I>>
public void remove()
Connectable
remove
in interface Connectable<I extends Injection<I>>
public MergingView getNetwork()
Identifiable
getNetwork
in interface Identifiable<I extends Identifiable<I>>
public String getId()
Identifiable
getId
in interface Identifiable<I extends Identifiable<I>>
public Optional<String> getOptionalName()
Identifiable
getOptionalName
in interface Identifiable<I extends Identifiable<I>>
public String getNameOrId()
Identifiable
getNameOrId
in interface Identifiable<I extends Identifiable<I>>
public boolean hasProperty()
Identifiable
hasProperty
in interface Identifiable<I extends Identifiable<I>>
public boolean hasProperty(String key)
Identifiable
hasProperty
in interface Identifiable<I extends Identifiable<I>>
public String getProperty(String key)
Identifiable
getProperty
in interface Identifiable<I extends Identifiable<I>>
public String getProperty(String key, String defaultValue)
Identifiable
getProperty
in interface Identifiable<I extends Identifiable<I>>
public String setProperty(String key, String value)
Identifiable
setProperty
in interface Identifiable<I extends Identifiable<I>>
public Set<String> getPropertyNames()
Identifiable
getPropertyNames
in interface Identifiable<I extends Identifiable<I>>
public boolean isFictitious()
Identifiable
isFictitious
in interface Identifiable<I extends Identifiable<I>>
public void setFictitious(boolean fictitious)
Identifiable
setFictitious
in interface Identifiable<I extends Identifiable<I>>
public <E extends Extension<I>> void addExtension(Class<? super E> type, E extension)
Extendable
addExtension
in interface Extendable<I extends Identifiable<I>>
E
- the extension typetype
- the extension class typeextension
- the extensionpublic <E extends Extension<I>> E getExtension(Class<? super E> type)
Extendable
getExtension
in interface Extendable<I extends Identifiable<I>>
E
- the extension typetype
- the extension class typepublic <E extends Extension<I>> E getExtensionByName(String name)
Extendable
getExtensionByName
in interface Extendable<I extends Identifiable<I>>
name
- the extension namepublic <E extends Extension<I>> boolean removeExtension(Class<E> type)
Extendable
removeExtension
in interface Extendable<I extends Identifiable<I>>
E
- the extension typetype
- the extension class typepublic <E extends Extension<I>> Collection<E> getExtensions()
Extendable
getExtensions
in interface Extendable<I extends Identifiable<I>>
public <E extends Extension<I>,B extends ExtensionAdder<I,E>> B newExtension(Class<B> type)
Extendable
The extension implementation is selected at runtime based on matching the
Extendable.getImplementationName()
of this extendable to the
ExtensionAdderProvider.getImplementationName()
of a provider.
Implementations are loaded with java's ServiceLoader
using
the ExtensionAdderProvider interface.
newExtension
in interface Extendable<I extends Identifiable<I>>
type
- The interface of the ExtensionAdderprotected I getDelegate()
protected com.powsybl.iidm.mergingview.MergingViewIndex getIndex()
Copyright © 2020. All rights reserved.