Package com.powsybl.iidm.mergingview

Class TieLineAdapter

java.lang.Object

com.powsybl.iidm.mergingview.LineAdapter

com.powsybl.iidm.mergingview.TieLineAdapter

All Implemented Interfaces:

Extendable<Line>, Branch<Line>, Connectable<Line>, Identifiable<Line>, Line, LineCharacteristics<Line>, TieLine

public class TieLineAdapter
extends LineAdapter
implements TieLine

Author:

Thomas Adam

Nested Class Summary

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

Branch.Overload, Branch.Side

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

TieLine.HalfLine

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.
boolean	checkPermanentLimit(Branch.Side side, float limitReduction, LimitType type)
boolean	checkPermanentLimit(Branch.Side side, LimitType type)
boolean	checkPermanentLimit1(float limitReduction, LimitType type)
boolean	checkPermanentLimit1(LimitType type)
boolean	checkPermanentLimit2(float limitReduction, LimitType type)
boolean	checkPermanentLimit2(LimitType type)
Branch.Overload	checkTemporaryLimits(Branch.Side side, float limitReduction, LimitType type)
Branch.Overload	checkTemporaryLimits(Branch.Side side, LimitType type)
Branch.Overload	checkTemporaryLimits1(float limitReduction, LimitType type)
Branch.Overload	checkTemporaryLimits1(LimitType type)
Branch.Overload	checkTemporaryLimits2(float limitReduction, LimitType type)
Branch.Overload	checkTemporaryLimits2(LimitType type)
ActivePowerLimits	getActivePowerLimits1()
ActivePowerLimits	getActivePowerLimits2()
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.
ApparentPowerLimits	getApparentPowerLimits1()
ApparentPowerLimits	getApparentPowerLimits2()
CurrentLimits	getCurrentLimits1()
CurrentLimits	getCurrentLimits2()
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..
TieLine.HalfLine	getHalf(Branch.Side side)	Get a given side half of the line characteristics
TieLine.HalfLine	getHalf1()	Get first half of the line characteristics
TieLine.HalfLine	getHalf2()	Get second half of the line characteristics
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()
String	getNameOrId()	Get the name of the object if it exists.
MergingView	getNetwork()	Get the network associated to the object.
Collection<OperationalLimits>	getOperationalLimits1()
Collection<OperationalLimits>	getOperationalLimits2()
Optional<String>	getOptionalName()	Return an optional containing the name of the object if it exists.
int	getOverloadDuration()
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.
Branch.Side	getSide(Terminal terminal)
Terminal	getTerminal(Branch.Side side)
Terminal	getTerminal(String voltageLevelId)
Terminal	getTerminal1()	Get the first terminal.
Terminal	getTerminal2()	Get the second terminal.
List<? extends Terminal>	getTerminals()
IdentifiableType	getType()	Get identifiable type.
String	getUcteXnodeCode()	Get the UCTE Xnode code corresponding to this line in the case where the line is a boundary, return null otherwise.
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	isOverloaded()	Only checks overloading for LimitType.Current and permanent limits
boolean	isOverloaded(float limitReduction)	Only checks overloading for LimitType.Current and permanent limits
ActivePowerLimitsAdder	newActivePowerLimits1()
ActivePowerLimitsAdder	newActivePowerLimits2()
ApparentPowerLimitsAdder	newApparentPowerLimits1()
ApparentPowerLimitsAdder	newApparentPowerLimits2()
CurrentLimitsAdder	newCurrentLimits1()
CurrentLimitsAdder	newCurrentLimits2()
<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(boolean removeDanglingSwitches)	Remove the connectable from the voltage level.
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.
boolean	removeProperty(String key)	Remove property with specified key.
void	setFictitious(boolean fictitious)	Set the fictitious status
String	setProperty(String key, String value)	Set property value associated to specified key.

Methods inherited from class com.powsybl.iidm.mergingview.LineAdapter

getB1, getB2, getG1, getG2, getR, getX, isTieLine, setB1, setB2, setG1, setG2, setR, setX

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.Branch

checkPermanentLimit, checkPermanentLimit, checkPermanentLimit, checkPermanentLimit, checkPermanentLimit1, checkPermanentLimit1, checkPermanentLimit1, checkPermanentLimit1, checkPermanentLimit2, checkPermanentLimit2, checkPermanentLimit2, checkPermanentLimit2, checkTemporaryLimits, checkTemporaryLimits, checkTemporaryLimits, checkTemporaryLimits, checkTemporaryLimits1, checkTemporaryLimits1, checkTemporaryLimits1, checkTemporaryLimits1, checkTemporaryLimits2, checkTemporaryLimits2, checkTemporaryLimits2, checkTemporaryLimits2, getActivePowerLimits, getActivePowerLimits1, getActivePowerLimits2, getApparentPowerLimits, getApparentPowerLimits1, getApparentPowerLimits2, getCurrentLimits, getCurrentLimits1, getCurrentLimits2, getLimits, getOperationalLimits1, getOperationalLimits2, getOverloadDuration, getSide, getTerminal, getTerminal, getTerminal1, getTerminal2, isOverloaded, isOverloaded, newActivePowerLimits1, newActivePowerLimits2, newApparentPowerLimits1, newApparentPowerLimits2, newCurrentLimits1, newCurrentLimits2

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

getTerminals, remove, remove

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

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

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

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

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

getType, isTieLine

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

getB1, getB2, getG1, getG2, getR, getX, setB1, setB2, setG1, setG2, setR, setX

Method Detail

getUcteXnodeCode

public String getUcteXnodeCode()

Description copied from interface: TieLine

Get the UCTE Xnode code corresponding to this line in the case where the line is a boundary, return null otherwise.

Specified by:

getUcteXnodeCode in interface TieLine

getHalf1

public TieLine.HalfLine getHalf1()

Description copied from interface: TieLine

Get first half of the line characteristics

Specified by:

getHalf1 in interface TieLine

getHalf2

public TieLine.HalfLine getHalf2()

Description copied from interface: TieLine

Get second half of the line characteristics

Specified by:

getHalf2 in interface TieLine

getHalf

public TieLine.HalfLine getHalf(Branch.Side side)

Description copied from interface: TieLine

Get a given side half of the line characteristics

Specified by:

getHalf in interface TieLine

getTerminal1

public Terminal getTerminal1()

Description copied from interface: Branch

Get the first terminal.

Specified by:

getTerminal1 in interface Branch<I extends Branch<I>>

getTerminal2

public Terminal getTerminal2()

Description copied from interface: Branch

Get the second terminal.

Specified by:

getTerminal2 in interface Branch<I extends Branch<I>>

getTerminal

public Terminal getTerminal(Branch.Side side)

Specified by:

getTerminal in interface Branch<I extends Branch<I>>

getTerminal

public Terminal getTerminal(String voltageLevelId)

Specified by:

getTerminal in interface Branch<I extends Branch<I>>

getSide

public Branch.Side getSide(Terminal terminal)

Specified by:

getSide in interface Branch<I extends Branch<I>>

getOperationalLimits1

public Collection<OperationalLimits> getOperationalLimits1()

Specified by:

getOperationalLimits1 in interface Branch<I extends Branch<I>>

getCurrentLimits1

public CurrentLimits getCurrentLimits1()

Specified by:

getCurrentLimits1 in interface Branch<I extends Branch<I>>

newCurrentLimits1

public CurrentLimitsAdder newCurrentLimits1()

Specified by:

newCurrentLimits1 in interface Branch<I extends Branch<I>>

getApparentPowerLimits1

public ApparentPowerLimits getApparentPowerLimits1()

Specified by:

getApparentPowerLimits1 in interface Branch<I extends Branch<I>>

newApparentPowerLimits1

public ApparentPowerLimitsAdder newApparentPowerLimits1()

Specified by:

newApparentPowerLimits1 in interface Branch<I extends Branch<I>>

getActivePowerLimits1

public ActivePowerLimits getActivePowerLimits1()

Specified by:

getActivePowerLimits1 in interface Branch<I extends Branch<I>>

newActivePowerLimits1

public ActivePowerLimitsAdder newActivePowerLimits1()

Specified by:

newActivePowerLimits1 in interface Branch<I extends Branch<I>>

getOperationalLimits2

public Collection<OperationalLimits> getOperationalLimits2()

Specified by:

getOperationalLimits2 in interface Branch<I extends Branch<I>>

getCurrentLimits2

public CurrentLimits getCurrentLimits2()

Specified by:

getCurrentLimits2 in interface Branch<I extends Branch<I>>

newCurrentLimits2

public CurrentLimitsAdder newCurrentLimits2()

Specified by:

newCurrentLimits2 in interface Branch<I extends Branch<I>>

getApparentPowerLimits2

public ApparentPowerLimits getApparentPowerLimits2()

Specified by:

getApparentPowerLimits2 in interface Branch<I extends Branch<I>>

newApparentPowerLimits2

public ApparentPowerLimitsAdder newApparentPowerLimits2()

Specified by:

newApparentPowerLimits2 in interface Branch<I extends Branch<I>>

getActivePowerLimits2

public ActivePowerLimits getActivePowerLimits2()

Specified by:

getActivePowerLimits2 in interface Branch<I extends Branch<I>>

newActivePowerLimits2

public ActivePowerLimitsAdder newActivePowerLimits2()

Specified by:

newActivePowerLimits2 in interface Branch<I extends Branch<I>>

isOverloaded

public boolean isOverloaded()

Description copied from interface: Branch

Only checks overloading for LimitType.Current and permanent limits

Specified by:

isOverloaded in interface Branch<I extends Branch<I>>

isOverloaded

public boolean isOverloaded(float limitReduction)

Description copied from interface: Branch

Only checks overloading for LimitType.Current and permanent limits

Specified by:

isOverloaded in interface Branch<I extends Branch<I>>

getOverloadDuration

public int getOverloadDuration()

Specified by:

getOverloadDuration in interface Branch<I extends Branch<I>>

checkPermanentLimit

public boolean checkPermanentLimit(Branch.Side side,
                                   float limitReduction,
                                   LimitType type)

Specified by:

checkPermanentLimit in interface Branch<I extends Branch<I>>

checkPermanentLimit

public boolean checkPermanentLimit(Branch.Side side,
                                   LimitType type)

Specified by:

checkPermanentLimit in interface Branch<I extends Branch<I>>

checkPermanentLimit1

public boolean checkPermanentLimit1(float limitReduction,
                                    LimitType type)

Specified by:

checkPermanentLimit1 in interface Branch<I extends Branch<I>>

checkPermanentLimit1

public boolean checkPermanentLimit1(LimitType type)

Specified by:

checkPermanentLimit1 in interface Branch<I extends Branch<I>>

checkPermanentLimit2

public boolean checkPermanentLimit2(float limitReduction,
                                    LimitType type)

Specified by:

checkPermanentLimit2 in interface Branch<I extends Branch<I>>

checkPermanentLimit2

public boolean checkPermanentLimit2(LimitType type)

Specified by:

checkPermanentLimit2 in interface Branch<I extends Branch<I>>

checkTemporaryLimits

public Branch.Overload checkTemporaryLimits(Branch.Side side,
                                            float limitReduction,
                                            LimitType type)

Specified by:

checkTemporaryLimits in interface Branch<I extends Branch<I>>

checkTemporaryLimits

public Branch.Overload checkTemporaryLimits(Branch.Side side,
                                            LimitType type)

Specified by:

checkTemporaryLimits in interface Branch<I extends Branch<I>>

checkTemporaryLimits1

public Branch.Overload checkTemporaryLimits1(float limitReduction,
                                             LimitType type)

Specified by:

checkTemporaryLimits1 in interface Branch<I extends Branch<I>>

checkTemporaryLimits1

public Branch.Overload checkTemporaryLimits1(LimitType type)

Specified by:

checkTemporaryLimits1 in interface Branch<I extends Branch<I>>

checkTemporaryLimits2

public Branch.Overload checkTemporaryLimits2(float limitReduction,
                                             LimitType type)

Specified by:

checkTemporaryLimits2 in interface Branch<I extends Branch<I>>

checkTemporaryLimits2

public Branch.Overload checkTemporaryLimits2(LimitType type)

Specified by:

checkTemporaryLimits2 in interface Branch<I extends Branch<I>>

getTerminals

public final List<? extends Terminal> getTerminals()

Specified by:

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

remove

public final void remove(boolean removeDanglingSwitches)

Description copied from interface: Connectable

Remove the connectable from the voltage level.

Specified by:

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

Parameters:

removeDanglingSwitches - if true, also remove dangling switches in addition to isolated nodes

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>>

removeProperty

public boolean removeProperty(String key)

Description copied from interface: Identifiable

Remove property with specified key.

Specified by:

removeProperty in interface Identifiable<I extends Identifiable<I>>

Parameters:

key - the property key

Returns:

true if property exists and has been removed, false otherwise

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>>

getType

public IdentifiableType getType()

Description copied from interface: Identifiable

Get identifiable type.

Specified by:

getType in interface Identifiable<I extends Identifiable<I>>

Returns:

the identifiable type

getDelegate

protected I getDelegate()

getIndex

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