Package com.powsybl.action

Class TerminalsConnectionAction

java.lang.Object

com.powsybl.action.AbstractAction

com.powsybl.action.TerminalsConnectionAction

All Implemented Interfaces:

Action

public class TerminalsConnectionAction
extends AbstractAction

An action of opening or closing an equipment terminal(s).

Author:

Anne Tilloy <[email protected]>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
TerminalsConnectionAction(String id, String elementId, boolean open)
TerminalsConnectionAction(String id, String elementId, ThreeSides side, boolean open)

Method Summary

Modifier and Type	Method	Description
String	getElementId()
Optional<ThreeSides>	getSide()	The side is optional.
String	getType()
boolean	isOpen()	If true, applying the action will open the terminal reference with side is given, else it will close it.

Methods inherited from class com.powsybl.action.AbstractAction

getId

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

TerminalsConnectionAction

public TerminalsConnectionAction(String id,
 String elementId,
 ThreeSides side,
 boolean open)

Parameters:

id - the id of the action.

elementId - the id of the element which terminals are operated. The element can be any connectable, including a tie line by referring the terminal of an underlying dangling line.

side - the side of the element to operate in the action.

open - the status for the terminal to operate. true means terminal opening.

TerminalsConnectionAction

public TerminalsConnectionAction(String id,
 String elementId,
 boolean open)

Parameters:

id - the id of the action.

elementId - the id of the element which terminals are operated. The element can be any connectable, including a tie line by referring the terminal of an underlying dangling line.

open - the status for all the terminals of the element to operate. true means all terminals opening.

Method Details

getType

public String getType()

getElementId

public String getElementId()

Returns:

the element id.

getSide

public Optional<ThreeSides> getSide()

The side is optional. Empty means that all the terminals of the element will be operated in the action with the defined open or close status.

Returns:

the optional side of the connection/disconnection action.

isOpen

public boolean isOpen()

If true, applying the action will open the terminal reference with side is given, else it will close it. If the side is not given, if true, applying the action will open all the terminals of the element, else it will close them.