com.powsybl.iidm.mergingview

Class VscConverterStationAdapter

java.lang.Object

com.powsybl.iidm.mergingview.VscConverterStationAdapter

All Implemented Interfaces:

Extendable<VscConverterStation>, Connectable<VscConverterStation>, HvdcConverterStation<VscConverterStation>, Identifiable<VscConverterStation>, Injection<VscConverterStation>, ReactiveLimitsHolder, VscConverterStation

public class VscConverterStationAdapter
extends Object
implements VscConverterStation

Author:

Thomas Adam

Nested Class Summary

Nested classes/interfaces inherited from interface com.powsybl.iidm.network.HvdcConverterStation

HvdcConverterStation.HvdcType

Method Summary

Modifier and Type	Method and Description
<E extends Extension<I>> void	addExtension(Class<? super E> type, E extension) Add en extension to this extendable object.
protected I	getDelegate()
<E extends Extension<I>> E	getExtension(Class<? super E> type) Get an extension based on its class type.
<E extends Extension<I>> E	getExtensionByName(String name) Get an extension based on its name.
<E extends Extension<I>> Collection<E>	getExtensions() Get all extensions associated with this extendable object..
HvdcLine	getHvdcLine() Return the HVDC line attached to this station.
HvdcConverterStation.HvdcType	getHvdcType() Get HVDC type.
String	getId() Get the unique identifier of the object.
String	getImplementationName() Returns a name that is used to find matching ExtensionAdderProviders when selecting implementations of extensions in Extendable.newExtension(java.lang.Class<B>).
protected com.powsybl.iidm.mergingview.MergingViewIndex	getIndex()
float	getLossFactor() Get the loss factor.
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.
ReactiveLimits	getReactiveLimits() Get reactive limits of the generator.
<L extends ReactiveLimits> L	getReactiveLimits(Class<L> type)
double	getReactivePowerSetpoint() Get the reactive power setpoint (MVar).
Terminal	getTerminal() Get the terminal.
List<? extends Terminal>	getTerminals()
ConnectableType	getType() Get the connectable type.
double	getVoltageSetpoint() Get the voltage setpoint (Kv).
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() Check if voltage regulator is on.
<E extends Extension<I>,B extends ExtensionAdder<I,E>> B	newExtension(Class<B> type) Returns an extensionAdder to build and add an extension for this extendable.
MinMaxReactiveLimitsAdder	newMinMaxReactiveLimits() Get a builder to create and associate minimum and maximum reactive limits to this generator.
ReactiveCapabilityCurveAdder	newReactiveCapabilityCurve() Get a builder to create and associate a new reactive capability curve to this generator.
void	remove() Remove the equipment.
<E extends Extension<I>> boolean	removeExtension(Class<E> type) Remove an extension based on its class type.
void	setFictitious(boolean fictitious) Set the fictitious status
I	setLossFactor(float lossFactor) Set the loss factor
String	setProperty(String key, String value) Set property value associated to specified key.
HvdcConverterStation	setReactivePowerSetpoint(double reactivePowerSetpoint) Set the reactive power setpoint (MVar).
HvdcConverterStation	setVoltageRegulatorOn(boolean voltageRegulatorOn) Set voltage regulator status.
HvdcConverterStation	setVoltageSetpoint(double voltageSetpoint) Set the voltage setpoint (Kv).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getHvdcLine, getHvdcType, getLossFactor, setLossFactor

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, getNameOrId, getNetwork, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasProperty, hasProperty, isFictitious, setFictitious, setProperty

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

addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension

Method Detail

setVoltageRegulatorOn

public HvdcConverterStation setVoltageRegulatorOn(boolean voltageRegulatorOn)

Description copied from interface: VscConverterStation

Set voltage regulator status.

Specified by:

setVoltageRegulatorOn in interface VscConverterStation

Parameters:

voltageRegulatorOn - the new voltage regulator status

Returns:

the converter itself to allow method chaining

setVoltageSetpoint

public HvdcConverterStation setVoltageSetpoint(double voltageSetpoint)

Description copied from interface: VscConverterStation

Set the voltage setpoint (Kv).

Specified by:

setVoltageSetpoint in interface VscConverterStation

Parameters:

voltageSetpoint - the voltage setpoint

Returns:

the converter itself to allow method chaining

setReactivePowerSetpoint

public HvdcConverterStation setReactivePowerSetpoint(double reactivePowerSetpoint)

Description copied from interface: VscConverterStation

Set the reactive power setpoint (MVar).

Specified by:

setReactivePowerSetpoint in interface VscConverterStation

Parameters:

reactivePowerSetpoint - the reactive power setpoint

Returns:

the converter itself to allow method chaining

getReactiveLimits

public ReactiveLimits getReactiveLimits()

Description copied from interface: ReactiveLimitsHolder

Get reactive limits of the generator.

Specified by:

getReactiveLimits in interface ReactiveLimitsHolder

getReactiveLimits

public <L extends ReactiveLimits> L getReactiveLimits(Class<L> type)

Specified by:

getReactiveLimits in interface ReactiveLimitsHolder

newReactiveCapabilityCurve

public ReactiveCapabilityCurveAdder newReactiveCapabilityCurve()

Description copied from interface: ReactiveLimitsHolder

Get a builder to create and associate a new reactive capability curve to this generator.

Specified by:

newReactiveCapabilityCurve in interface ReactiveLimitsHolder

newMinMaxReactiveLimits

public MinMaxReactiveLimitsAdder newMinMaxReactiveLimits()

Description copied from interface: ReactiveLimitsHolder

Get a builder to create and associate minimum and maximum reactive limits to this generator.

Specified by:

newMinMaxReactiveLimits in interface ReactiveLimitsHolder

isVoltageRegulatorOn

public boolean isVoltageRegulatorOn()

Description copied from interface: VscConverterStation

Check if voltage regulator is on.

Specified by:

isVoltageRegulatorOn in interface VscConverterStation

Returns:

true if voltage regulator is on, false otherwise

getVoltageSetpoint

public double getVoltageSetpoint()

Description copied from interface: VscConverterStation

Get the voltage setpoint (Kv).

Specified by:

getVoltageSetpoint in interface VscConverterStation

Returns:

the voltage setpoint

getReactivePowerSetpoint

public double getReactivePowerSetpoint()

Description copied from interface: VscConverterStation

Get the reactive power setpoint (MVar).

Specified by:

getReactivePowerSetpoint in interface VscConverterStation

Returns:

the reactive power setpoint

getHvdcLine

public HvdcLine getHvdcLine()

Description copied from interface: HvdcConverterStation

Return the HVDC line attached to this station.

Specified by:

getHvdcLine in interface HvdcConverterStation<I extends HvdcConverterStation<I>>

Returns:

the HVDC line attached to this station or null.

setLossFactor

public I setLossFactor(float lossFactor)

Description copied from interface: HvdcConverterStation

Set the loss factor

Specified by:

setLossFactor in interface HvdcConverterStation<I extends HvdcConverterStation<I>>

Parameters:

lossFactor - the loss factor

Returns:

this station

getHvdcType

public HvdcConverterStation.HvdcType getHvdcType()

Description copied from interface: HvdcConverterStation

Get HVDC type.

Specified by:

getHvdcType in interface HvdcConverterStation<I extends HvdcConverterStation<I>>

Returns:

HVDC type

getLossFactor

public float getLossFactor()

Description copied from interface: HvdcConverterStation

Get the loss factor.

Specified by:

getLossFactor in interface HvdcConverterStation<I extends HvdcConverterStation<I>>

Returns:

the loss factor.

getTerminal

public final Terminal getTerminal()

Description copied from interface: Injection

Get the terminal.

Specified by:

getTerminal in interface Injection<I extends Injection<I>>

getType

public final ConnectableType getType()

Description copied from interface: Connectable

Get the connectable type.

Specified by:

getType in interface Connectable<I extends Connectable<I>>

getTerminals

public final List<? extends Terminal> getTerminals()

Specified by:

getTerminals in interface Connectable<I extends Connectable<I>>

remove

public final void remove()

Description copied from interface: Connectable

Remove the equipment.

Specified by:

remove in interface Connectable<I extends Connectable<I>>

getNetwork

public MergingView getNetwork()

Description copied from interface: Identifiable

Get the network associated to the object.

Specified by:

getNetwork in interface Identifiable<I extends Identifiable<I>>

getId

public String getId()

Description copied from interface: Identifiable

Get the unique identifier of the object.

Specified by:

getId in interface Identifiable<I extends Identifiable<I>>

getOptionalName

public Optional<String> getOptionalName()

Description copied from interface: Identifiable

Return an optional containing the name of the object if it exists. If not, return an empty optional.

Specified by:

getOptionalName in interface Identifiable<I extends Identifiable<I>>

getNameOrId

public String getNameOrId()

Description copied from interface: Identifiable

Get the name of the object if it exists. If not, get the unique identifier of the object.

Specified by:

getNameOrId in interface Identifiable<I extends Identifiable<I>>

hasProperty

public boolean hasProperty()

Description copied from interface: Identifiable

Check that this object has some properties.

Specified by:

hasProperty in interface Identifiable<I extends Identifiable<I>>

hasProperty

public boolean hasProperty(String key)

Description copied from interface: Identifiable

Check that this object has property with specified name.

Specified by:

hasProperty in interface Identifiable<I extends Identifiable<I>>

getProperty

public String getProperty(String key)

Description copied from interface: Identifiable

Get property associated to specified key.

Specified by:

getProperty in interface Identifiable<I extends Identifiable<I>>

getProperty

public String getProperty(String key,
                          String defaultValue)

Description copied from interface: Identifiable

Get property associated to specified key, with default value.

Specified by:

getProperty in interface Identifiable<I extends Identifiable<I>>

setProperty

public String setProperty(String key,
                          String value)

Description copied from interface: Identifiable

Set property value associated to specified key.

Specified by:

setProperty in interface Identifiable<I extends Identifiable<I>>

getPropertyNames

public Set<String> getPropertyNames()

Description copied from interface: Identifiable

Get properties key values.

Specified by:

getPropertyNames in interface Identifiable<I extends Identifiable<I>>

isFictitious

public boolean isFictitious()

Description copied from interface: Identifiable

Get the fictitious status

Specified by:

isFictitious in interface Identifiable<I extends Identifiable<I>>

setFictitious

public void setFictitious(boolean fictitious)

Description copied from interface: Identifiable

Set the fictitious status

Specified by:

setFictitious in interface Identifiable<I extends Identifiable<I>>

addExtension

public <E extends Extension<I>> void addExtension(Class<? super E> type,
                                                  E extension)

Description copied from interface: Extendable

Add en extension to this extendable object.

Specified by:

addExtension in interface Extendable<I extends Identifiable<I>>

Type Parameters:

E - the extension type

Parameters:

type - the extension class type

extension - the extension

getExtension

public <E extends Extension<I>> E getExtension(Class<? super E> type)

Description copied from interface: Extendable

Get an extension based on its class type.

Specified by:

getExtension in interface Extendable<I extends Identifiable<I>>

Type Parameters:

E - the extension type

Parameters:

type - the extension class type

Returns:

the extension mapped to the class type or null if not found

getExtensionByName

public <E extends Extension<I>> E getExtensionByName(String name)

Description copied from interface: Extendable

Get an extension based on its name.

Specified by:

getExtensionByName in interface Extendable<I extends Identifiable<I>>

Parameters:

name - the extension name

Returns:

the extension mapped to the name or null if not found

removeExtension

public <E extends Extension<I>> boolean removeExtension(Class<E> type)

Description copied from interface: Extendable

Remove an extension based on its class type.

Specified by:

removeExtension in interface Extendable<I extends Identifiable<I>>

Type Parameters:

E - the extension type

Parameters:

type - the extension class type

Returns:

true if the extension has been removed false if extension has not been found

getExtensions

public <E extends Extension<I>> Collection<E> getExtensions()

Description copied from interface: Extendable

Get all extensions associated with this extendable object..

Specified by:

getExtensions in interface Extendable<I extends Identifiable<I>>

Returns:

all extensions associated to this extendable object.

getImplementationName

public String getImplementationName()

Description copied from interface: Extendable

Returns a name that is used to find matching ExtensionAdderProviders when selecting implementations of extensions in Extendable.newExtension(java.lang.Class<B>). This is meant to be overriden by extendables when multiple implementations exist.

Specified by:

getImplementationName in interface Extendable<I extends Identifiable<I>>

Returns:

the name

newExtension

public <E extends Extension<I>,B extends ExtensionAdder<I,E>> B newExtension(Class<B> type)

Description copied from interface: Extendable

Returns an extensionAdder to build and add an extension for this 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.

Specified by:

newExtension in interface Extendable<I extends Identifiable<I>>

Parameters:

type - The interface of the ExtensionAdder

Returns:

the adder

getDelegate

protected I getDelegate()

getIndex

protected com.powsybl.iidm.mergingview.MergingViewIndex getIndex()