public class ShuntCompensatorAdapter extends Object implements ShuntCompensator
Modifier and Type | Method and Description |
---|---|
void |
addAlias(String alias)
Add an alias to the object.
|
void |
addAlias(String alias,
String aliasType)
Add an alias to the object.
|
<E extends Extension<I>> |
addExtension(Class<? super E> type,
E extension)
Add en extension to this extendable object.
|
Set<String> |
getAliases()
Get the aliases of the object.
|
Optional<String> |
getAliasFromType(String aliasType)
Get the alias of the object with a given alias type if it exists.
|
Optional<String> |
getAliasType(String alias)
Get the alias type of an alias if it exists, an empty optional otherwise.
|
double |
getB()
Get the susceptance (in S) of the shunt in its current state i.e. the sum of the sections' susceptances for all sections in service.
|
double |
getB(int sectionCount)
Get the susceptance (in S) for a given activated sections count i.e. the sum of the sections' susceptances from 1 to sectionCount.
|
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..
|
double |
getG()
Get the conductance (in S) of the shunt in its current state i.e. the sum of the sections' conductances for all sections in service.
|
double |
getG(int sectionCount)
Get the conductance (in S) for a given activated sections count i.e. the sum of the sections' conductances from 1 to sectionCount.
|
String |
getId()
Get the unique identifier of the object.
|
String |
getImplementationName()
Returns a name that is used to find matching
ExtensionAdderProvider s
when selecting implementations of extensions in Extendable.newExtension(java.lang.Class<B>) . |
protected com.powsybl.iidm.mergingview.MergingViewIndex |
getIndex() |
int |
getMaximumSectionCount()
Get the maximum number of sections that can be in service
|
ShuntCompensatorModel |
getModel()
Get the shunt model.
|
<M extends ShuntCompensatorModel> |
getModel(Class<M> modelType) |
ShuntCompensatorModelType |
getModelType()
Get the model type of the shunt compensator (linear or non-linear)
|
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.
|
int |
getSectionCount()
Get the count of sections in service.
|
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 |
hasAliases()
Return true if identifiable has aliases.
|
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.
|
void |
removeAlias(String alias)
Remove an alias of the object.
|
<E extends Extension<I>> |
removeExtension(Class<E> type)
Remove an extension based on its class type.
|
void |
setFictitious(boolean fictitious)
Set the fictitious status
|
String |
setProperty(String key,
String value)
Set property value associated to specified key.
|
ShuntCompensator |
setRegulatingTerminal(Terminal regulatingTerminal)
Set the terminal used for regulation.
|
ShuntCompensator |
setSectionCount(int sectionCount)
Change the count of sections in service.
|
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
getTerminal
getTerminals, getType, remove
addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getName, getNameOrId, getNetwork, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, setFictitious, setProperty
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension
public int getSectionCount()
ShuntCompensator
It is expected to be greater than one and lesser than or equal to the maximum section count.
Depends on the working variant.
getSectionCount
in interface ShuntCompensator
VariantManager
public int getMaximumSectionCount()
ShuntCompensator
getMaximumSectionCount
in interface ShuntCompensator
public ShuntCompensator setSectionCount(int sectionCount)
ShuntCompensator
Depends on the working variant.
setSectionCount
in interface ShuntCompensator
sectionCount
- the number of sections wanted to be put in serviceVariantManager
public double getB()
ShuntCompensator
getB
in interface ShuntCompensator
Depends on the working variant.
,
VariantManager
public double getG()
ShuntCompensator
getG
in interface ShuntCompensator
Depends on the working variant.
,
VariantManager
public double getB(int sectionCount)
ShuntCompensator
getB
in interface ShuntCompensator
sectionCount
- count of wanted activated sections. Must be in [0; maximumSectionCount]. Else, throws a ValidationException
.public double getG(int sectionCount)
ShuntCompensator
getG
in interface ShuntCompensator
sectionCount
- count of wanted activated sections. Must be in [0; maximumSectionCount]. Else, throws a ValidationException
.public ShuntCompensatorModelType getModelType()
ShuntCompensator
getModelType
in interface ShuntCompensator
public ShuntCompensatorModel getModel()
ShuntCompensator
getModel
in interface ShuntCompensator
public <M extends ShuntCompensatorModel> M getModel(Class<M> modelType)
getModel
in interface ShuntCompensator
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 final Terminal getTerminal()
Injection
getTerminal
in interface Injection<I extends Injection<I>>
public final ConnectableType getType()
Connectable
getType
in interface Connectable<I extends Connectable<I>>
public final List<? extends Terminal> getTerminals()
getTerminals
in interface Connectable<I extends Connectable<I>>
public final void remove()
Connectable
remove
in interface Connectable<I extends Connectable<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 String getImplementationName()
Extendable
ExtensionAdderProvider
s
when selecting implementations of extensions in Extendable.newExtension(java.lang.Class<B>)
. This
is meant to be overriden by extendables when multiple implementations exist.getImplementationName
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 ExtensionAdderpublic Set<String> getAliases()
Identifiable
getAliases
in interface Identifiable<I extends Identifiable<I>>
public Optional<String> getAliasFromType(String aliasType)
Identifiable
getAliasFromType
in interface Identifiable<I extends Identifiable<I>>
public Optional<String> getAliasType(String alias)
Identifiable
getAliasType
in interface Identifiable<I extends Identifiable<I>>
public void addAlias(String alias)
Identifiable
PowsyblException
addAlias
in interface Identifiable<I extends Identifiable<I>>
public void addAlias(String alias, String aliasType)
Identifiable
PowsyblException
If a given non null type already has an associated alias for this object, throw a PowsyblException
addAlias
in interface Identifiable<I extends Identifiable<I>>
public void removeAlias(String alias)
Identifiable
PowsyblException
removeAlias
in interface Identifiable<I extends Identifiable<I>>
public boolean hasAliases()
Identifiable
hasAliases
in interface Identifiable<I extends Identifiable<I>>
protected I getDelegate()
protected com.powsybl.iidm.mergingview.MergingViewIndex getIndex()
Copyright © 2021. All rights reserved.