com.powsybl.iidm.mergingview

Class ThreeWindingsTransformerAdapter

java.lang.Object

com.powsybl.iidm.mergingview.ThreeWindingsTransformerAdapter

All Implemented Interfaces:

Extendable<ThreeWindingsTransformer>, Connectable<ThreeWindingsTransformer>, Identifiable<ThreeWindingsTransformer>, ThreeWindingsTransformer

public class ThreeWindingsTransformerAdapter
extends Object
implements ThreeWindingsTransformer

This adaptation hide true implementation of ThreeWindingsTransformer.

Author:

Thomas Adam

Nested Class Summary

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

ThreeWindingsTransformer.Leg, ThreeWindingsTransformer.Side

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..
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()
ThreeWindingsTransformer.Leg	getLeg1() Get the leg at the primary side.
ThreeWindingsTransformer.Leg	getLeg2() Get the leg at the secondary side.
ThreeWindingsTransformer.Leg	getLeg3() Get the leg at the tertiary side.
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.
double	getRatedU0() Get the ratedU at the fictitious bus in kV (also used as nominal voltage)
ThreeWindingsTransformer.Side	getSide(Terminal side) Get the side the terminal is connected to.
Substation	getSubstation() Get the substation to which the transformer belongs.
Terminal	getTerminal(ThreeWindingsTransformer.Side side)
List<? extends TerminalAdapter>	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
<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 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
String	setProperty(String key, String value) Set property value associated to specified key.

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

getLeg1

public ThreeWindingsTransformer.Leg getLeg1()

Description copied from interface: ThreeWindingsTransformer

Get the leg at the primary side.

Specified by:

getLeg1 in interface ThreeWindingsTransformer

getLeg2

public ThreeWindingsTransformer.Leg getLeg2()

Description copied from interface: ThreeWindingsTransformer

Get the leg at the secondary side.

Specified by:

getLeg2 in interface ThreeWindingsTransformer

getLeg3

public ThreeWindingsTransformer.Leg getLeg3()

Description copied from interface: ThreeWindingsTransformer

Get the leg at the tertiary side.

Specified by:

getLeg3 in interface ThreeWindingsTransformer

getTerminals

public List<? extends TerminalAdapter> getTerminals()

Specified by:

getTerminals in interface Connectable<ThreeWindingsTransformer>

getTerminal

public Terminal getTerminal(ThreeWindingsTransformer.Side side)

Specified by:

getTerminal in interface ThreeWindingsTransformer

getSide

public ThreeWindingsTransformer.Side getSide(Terminal side)

Description copied from interface: ThreeWindingsTransformer

Get the side the terminal is connected to.

Specified by:

getSide in interface ThreeWindingsTransformer

getSubstation

public Substation getSubstation()

Description copied from interface: ThreeWindingsTransformer

Get the substation to which the transformer belongs.

Specified by:

getSubstation in interface ThreeWindingsTransformer

getType

public ConnectableType getType()

Description copied from interface: Connectable

Get the connectable type.

Specified by:

getType in interface Connectable<ThreeWindingsTransformer>

getRatedU0

public double getRatedU0()

Description copied from interface: ThreeWindingsTransformer

Get the ratedU at the fictitious bus in kV (also used as nominal voltage)

Specified by:

getRatedU0 in interface ThreeWindingsTransformer

remove

public void remove()

Description copied from interface: Connectable

Remove the equipment.

Specified by:

remove in interface Connectable<ThreeWindingsTransformer>

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