Package com.powsybl.iidm.network
Interface Terminal
public interface Terminal
An equipment connection point in a substation topology.
- Author:
- Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
A bus/breaker view of the terminal.static interface
A bus view of the terminal.static interface
A node/breaker view of the terminal.static interface
Topology traversal handler -
Method Summary
Modifier and TypeMethodDescriptionboolean
connect()
Try to connect the terminal.
Depends on the working variant.boolean
Try to connect the terminal.
Depends on the working variant.boolean
Disconnect the terminal.
Depends on the working variant.boolean
disconnect
(Predicate<Switch> isSwitchOpenable) Disconnect the terminal.
Depends on the working variant.Get a view to access to bus/breaker topology informations at the terminal.Get a view to access to bus topology informations at the terminal.Get the equipment that is connected to the terminal.static Optional<ThreeSides>
getConnectableSide
(Terminal terminal) double
getI()
Get the current in A at the terminal.
Depends on the working variant.Get a view to access to node/breaker topology informations at the terminal.double
getP()
Get the active power in MW injected at the terminal.
Depends on the working variant.double
getQ()
Get the reactive power in MVAR injected at the terminal.
Depends on the working variant.getSide()
static Terminal
getTerminal
(Identifiable<?> identifiable, ThreeSides side) Get the substation to which the terminal belongs.boolean
Test if the terminal is connected.setP
(double p) Set the active power in MW injected at the terminal.
Depends on the working variant.setQ
(double q) Set the reactive power in MVAR injected at the terminal.
Depends on the working variant.void
traverse
(Terminal.TopologyTraverser traverser) Traverse the full network topology graph.void
traverse
(Terminal.TopologyTraverser traverser, TraversalType traversalType) Traverse the full network topology graph.
-
Method Details
-
getVoltageLevel
VoltageLevel getVoltageLevel()Get the substation to which the terminal belongs. -
getNodeBreakerView
Terminal.NodeBreakerView getNodeBreakerView()Get a view to access to node/breaker topology informations at the terminal. -
getBusBreakerView
Terminal.BusBreakerView getBusBreakerView()Get a view to access to bus/breaker topology informations at the terminal. -
getBusView
Terminal.BusView getBusView()Get a view to access to bus topology informations at the terminal. -
getConnectable
Connectable getConnectable()Get the equipment that is connected to the terminal. -
getP
double getP()Get the active power in MW injected at the terminal.
Depends on the working variant.- See Also:
-
setP
Set the active power in MW injected at the terminal.
Depends on the working variant.- See Also:
-
getQ
double getQ()Get the reactive power in MVAR injected at the terminal.
Depends on the working variant.- See Also:
-
setQ
Set the reactive power in MVAR injected at the terminal.
Depends on the working variant.- See Also:
-
getI
double getI()Get the current in A at the terminal.
Depends on the working variant.- See Also:
-
connect
boolean connect()Try to connect the terminal.
Depends on the working variant.- Returns:
- true if terminal has been connected, false otherwise
- See Also:
-
connect
Try to connect the terminal.
Depends on the working variant.- Returns:
- true if terminal has been connected, false otherwise
- See Also:
-
disconnect
boolean disconnect()Disconnect the terminal.
Depends on the working variant.- Returns:
- true if terminal has been disconnected, false otherwise
- See Also:
-
disconnect
Disconnect the terminal.
Depends on the working variant.- Parameters:
isSwitchOpenable
- predicate telling if a switch is considered openable- Returns:
- true if terminal has been disconnected, false otherwise
- See Also:
-
isConnected
boolean isConnected()Test if the terminal is connected.- Returns:
- true if the terminal is connected, false otherwise
-
traverse
Traverse the full network topology graph.- Parameters:
traverser
- traversal handler
-
traverse
Traverse the full network topology graph.- Parameters:
traverser
- traversal handlertraversalType
- traversal type
-
getConnectableSide
-
getTerminal
-
getSide
ThreeSides getSide()
-