Package com.powsybl.iidm.mergingview

Class HvdcLineAdapter

java.lang.Object

com.powsybl.iidm.mergingview.HvdcLineAdapter

All Implemented Interfaces:

Extendable<HvdcLine>, HvdcLine, Identifiable<HvdcLine>

public class HvdcLineAdapter
extends Object
implements HvdcLine

Author:

Thomas Adam

Nested Class Summary

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

HvdcLine.ConvertersMode, HvdcLine.Side

Method Summary

Modifier and Type	Method	Description
void	addAlias(String alias)	Add an alias to the object.
void	addAlias(String alias, boolean ensureAliasUnicity)
void	addAlias(String alias, String aliasType)	Add an alias to the object.
void	addAlias(String alias, String aliasType, boolean ensureAliasUnicity)
<E extends Extension<I>> void	addExtension(Class<? super E> type, E extension)	Add en extension to this extendable object.
double	getActivePowerSetpoint()	Get the active power setpoint (in MW).
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.
HvdcLine.ConvertersMode	getConvertersMode()	Get converters mode.
HvdcConverterStation<?>	getConverterStation1()	Get the HVDC converter station connected on side 1.
HvdcConverterStation<?>	getConverterStation2()	Get the HVDC converter station connected on side 2.
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..
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()
double	getMaxP()	Get the maximum active power (in MW).
String	getNameOrId()	Get the name of the object if it exists.
MergingView	getNetwork()	Get the network associated to the object.
double	getNominalV()	Get the nominal voltage (in Kv).
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.
double	getR()	Get resistance (in Ω) of the line.
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
<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.
void	remove()	Remove the HVDC line
void	removeAlias(String alias)	Remove an alias of the object.
<E extends Extension<I>> boolean	removeExtension(Class<E> type)	Remove an extension based on its class type.
HvdcLine	setActivePowerSetpoint(double activePowerSetpoint)	Set the active power setpoint (in MW).
HvdcLine	setConvertersMode(HvdcLine.ConvertersMode mode)	Change converters mode.
void	setFictitious(boolean fictitious)	Set the fictitious status
HvdcLine	setMaxP(double maxP)	Set the maximum active power (in MW).
HvdcLine	setNominalV(double nominalV)	Set the nominal voltage.
String	setProperty(String key, String value)	Set property value associated to specified key.
HvdcLine	setR(double r)	Set the resistance (in Ω) of the line.

Methods inherited from class java.lang.Object

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

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

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

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

getConverterStation, getNetwork

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

addAlias, addAlias, addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getName, getNameOrId, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, setFictitious, setProperty

Method Detail

getConverterStation1

public HvdcConverterStation<?> getConverterStation1()

Description copied from interface: HvdcLine

Get the HVDC converter station connected on side 1.

Specified by:

getConverterStation1 in interface HvdcLine

Returns:

the HVDC converter station connected on side 1

getConverterStation2

public HvdcConverterStation<?> getConverterStation2()

Description copied from interface: HvdcLine

Get the HVDC converter station connected on side 2.

Specified by:

getConverterStation2 in interface HvdcLine

Returns:

the HVDC converter station connected on side 2

getConvertersMode

public HvdcLine.ConvertersMode getConvertersMode()

Description copied from interface: HvdcLine

Get converters mode.

Specified by:

getConvertersMode in interface HvdcLine

Returns:

converters mode

setConvertersMode

public HvdcLine setConvertersMode(HvdcLine.ConvertersMode mode)

Description copied from interface: HvdcLine

Change converters mode.

Specified by:

setConvertersMode in interface HvdcLine

Parameters:

mode - converters mode

Returns:

the station itself to allow method chaining.

getR

public double getR()

Description copied from interface: HvdcLine

Get resistance (in Ω) of the line.

Specified by:

getR in interface HvdcLine

Returns:

the resistance of the line

setR

public HvdcLine setR(double r)

Description copied from interface: HvdcLine

Set the resistance (in Ω) of the line.

Specified by:

setR in interface HvdcLine

Parameters:

r - the resistance of the line

Returns:

the HVDC line itself to allow method chaining

getNominalV

public double getNominalV()

Description copied from interface: HvdcLine

Get the nominal voltage (in Kv).

Specified by:

getNominalV in interface HvdcLine

Returns:

the nominal voltage.

setNominalV

public HvdcLine setNominalV(double nominalV)

Description copied from interface: HvdcLine

Set the nominal voltage.

Specified by:

setNominalV in interface HvdcLine

Parameters:

nominalV - the nominal voltage.

Returns:

the HVDC line itself to allow method chaining

getActivePowerSetpoint

public double getActivePowerSetpoint()

Description copied from interface: HvdcLine

Get the active power setpoint (in MW).

Specified by:

getActivePowerSetpoint in interface HvdcLine

Returns:

the active power setpoint

setActivePowerSetpoint

public HvdcLine setActivePowerSetpoint(double activePowerSetpoint)

Description copied from interface: HvdcLine

Set the active power setpoint (in MW).

Specified by:

setActivePowerSetpoint in interface HvdcLine

Parameters:

activePowerSetpoint - the active power setpoint

Returns:

the HVDC line itself to allow method chaining

getMaxP

public double getMaxP()

Description copied from interface: HvdcLine

Get the maximum active power (in MW).

Specified by:

getMaxP in interface HvdcLine

Returns:

the maximum active power

setMaxP

public HvdcLine setMaxP(double maxP)

Description copied from interface: HvdcLine

Set the maximum active power (in MW).

Specified by:

setMaxP in interface HvdcLine

Parameters:

maxP - the maximum active power

Returns:

the HVDC line itself to allow method chaining

remove

public void remove()

Description copied from interface: HvdcLine

Remove the HVDC line

Specified by:

remove in interface HvdcLine

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

getAliases

public Set<String> getAliases()

Description copied from interface: Identifiable

Get the aliases of the object.

Specified by:

getAliases in interface Identifiable<I extends Identifiable<I>>

getAliasFromType

public Optional<String> getAliasFromType(String aliasType)

Description copied from interface: Identifiable

Get the alias of the object with a given alias type if it exists. Else return an empty optional.

Specified by:

getAliasFromType in interface Identifiable<I extends Identifiable<I>>

getAliasType

public Optional<String> getAliasType(String alias)

Description copied from interface: Identifiable

Get the alias type of an alias if it exists, an empty optional otherwise. If the alias does not exist, return an empty optional.

Specified by:

getAliasType in interface Identifiable<I extends Identifiable<I>>

addAlias

public void addAlias(String alias)

Description copied from interface: Identifiable

Add an alias to the object. Aliases must be unique in associated Network, and different from any identifiable ID. No alias type is associated to this alias. If the alias already exists (i.e. is not unique) or equals an identifiable ID, throw a PowsyblException

Specified by:

addAlias in interface Identifiable<I extends Identifiable<I>>

addAlias

public void addAlias(String alias,
                     boolean ensureAliasUnicity)

Specified by:

addAlias in interface Identifiable<I extends Identifiable<I>>

addAlias

public void addAlias(String alias,
                     String aliasType)

Description copied from interface: Identifiable

Add an alias to the object. Aliases must be unique in associated Network, and different from any identifiable ID. This alias is associated to a given alias type. If the given alias type is null or empty, no alias type is considered associated to the alias. Only one alias can be associated to a non null given alias type for one object. If the alias already exists (i.e. is not unique) or equals an identifiable ID, throw a PowsyblException If a given non null type already has an associated alias for this object, throw a PowsyblException

Specified by:

addAlias in interface Identifiable<I extends Identifiable<I>>

addAlias

public void addAlias(String alias,
                     String aliasType,
                     boolean ensureAliasUnicity)

Specified by:

addAlias in interface Identifiable<I extends Identifiable<I>>

removeAlias

public void removeAlias(String alias)

Description copied from interface: Identifiable

Remove an alias of the object. If the alias does not exist for this object, throw a PowsyblException

Specified by:

removeAlias in interface Identifiable<I extends Identifiable<I>>

hasAliases

public boolean hasAliases()

Description copied from interface: Identifiable

Return true if identifiable has aliases.

Specified by:

hasAliases in interface Identifiable<I extends Identifiable<I>>

getDelegate

protected I getDelegate()

getIndex

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