Package com.powsybl.iidm.network.extensions

Interface ReferencePriority

public interface ReferencePriority
ReferencePriority iIDM extension allow to specify priority for a Terminal. 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>
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    get(Branch<?> branch, TwoSides side)
    Get the priority of a branch side.
    static int
    get(Injection<?> injection)
    Get the reference priority of an injection.
    static int
    get(ThreeWindingsTransformer threeWindingsTransformer, ThreeSides side)
    Get the priority of a three windings transformer side.
    int
    getPriority()
    get the terminal reference priority
    Terminal
    getTerminal()
    get the terminal having a reference priority defined
    static void
    set(Branch<?> branch, TwoSides side, int priority)
    Set the reference priority of a branch side.
    static void
    set(Injection<?> injection, int priority)
    Set the reference priority of an injection.
    static void
    set(ThreeWindingsTransformer threeWindingsTransformer, ThreeSides side, int priority)
    Set the reference priority of a three windings transformer side.

  • Method Details

    • getTerminal

      Terminal getTerminal()
      get the terminal having a reference priority defined
      Returns:
      the terminal

    • getPriority

      int getPriority()
      get the terminal reference priority
      Returns:
      reference priority value

    • get

      static int get(Injection<?> injection)
      Get the reference priority of an injection.
      Parameters:
      injection - an injection
      Returns:
      reference priority value

    • get

      static int get(Branch<?> branch, TwoSides side)
      Get the priority of a branch side.
      Parameters:
      branch - a branch
      side - side to get priority from
      Returns:
      reference priority value

    • get

      static int get(ThreeWindingsTransformer threeWindingsTransformer, ThreeSides side)
      Get the priority of a three windings transformer side.
      Parameters:
      threeWindingsTransformer - a three windings transformer
      side - side to get priority from
      Returns:
      reference priority value

    • set

      static void set(Injection<?> injection, int priority)
      Set the reference priority of an injection.
      Parameters:
      injection - an injection
      priority - priority value to set

    • set

      static void set(Branch<?> branch, TwoSides side, int priority)
      Set the reference priority of a branch side.
      Parameters:
      branch - a branch
      side - side to set priority to
      priority - priority value to set

    • set

      static void set(ThreeWindingsTransformer threeWindingsTransformer, ThreeSides side, int priority)
      Set the reference priority of a three windings transformer side.
      Parameters:
      threeWindingsTransformer - a three windings transformer
      side - side to set priority to
      priority - priority value to set