Package com.powsybl.iidm.network.extensions

Interface ReferencePriorities<C extends Connectable<C>>

All Superinterfaces:
Extension<C>
public interface ReferencePriorities<C extends Connectable<C>> extends Extension<C>
ReferencePriorities iIDM extension allows specifying priorities among network equipments terminals for the selection of a reference bus, for example the angle reference in the context of a load flow.
The extension is attached to a Connectable, i.e. any equipment with Terminals.
A priority level can be defined, as an integer, for each Terminal of the connectable.
A priority 0 means should not be used. 1 is highest priority for selection. 2 is second highest priority, etc ...
Author:
Damien Jeandemange <damien.jeandemange at artelys.com>

  • Field Details

  • Method Details

    • getName

      default String getName()
      Description copied from interface: Extension
      Return the name of this extension.
      Specified by:
      getName in interface Extension<C extends Connectable<C>>

    • get

      static List<ReferencePriority> get(Network network, Comparator<ReferencePriority> connectableComparator)
      Gets the reference priorities defined in the network, sorted by decreasing priority (i.e. higher priorities are first in the list). Priorities 0 are filtered out. The connectableComparator is used to control the sorting of equal priority values. Note that this method provides "raw" priorities, API users would typically want to check whether the terminals are connected, in which SynchronousComponent the Terminal belongs to, etc ...
      Parameters:
      network - network from which reference priorities should be listed
      connectableComparator - comparator to

    • get

      static List<ReferencePriority> get(Network network)
      Gets the reference priorities defined in the network for the current variant, sorted by decreasing priority (i.e. higher priorities are first in the list). Priorities 0 are filtered out. In case of equal priority between different equipment types, generators are put first, busbar sections second, loads third, and all other equipment types last. Note that this method provides "raw" priorities, API users would typically want to check whether the terminals are connected, in which SynchronousComponent the Terminal belongs to, etc ...
      Parameters:
      network - network from which reference priorities should be listed
      Returns:
      list of sorted reference priorities

    • delete

      static void delete(Network network)
      Deletes all defined reference priorities in the network for the current variant
      Parameters:
      network - network whose reference priorities should be deleted

    • newReferencePriority

      ReferencePriorityAdder newReferencePriority()

    • getReferencePriorities

      List<ReferencePriority> getReferencePriorities()

    • deleteReferencePriorities

      void deleteReferencePriorities()