Package com.powsybl.security.limitreduction.result

Record Class AbstractReducedLoadingLimits.ReducedTemporaryLimit

java.lang.Object
java.lang.Record
com.powsybl.security.limitreduction.result.AbstractReducedLoadingLimits.ReducedTemporaryLimit
All Implemented Interfaces:
LoadingLimits.TemporaryLimit
Enclosing class:
AbstractReducedLoadingLimits
public static record AbstractReducedLoadingLimits.ReducedTemporaryLimit(String name, double value, int acceptableDuration, boolean fictitious, double originalValue, double limitReduction) extends Record implements LoadingLimits.TemporaryLimit

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReducedTemporaryLimit(String name, double value, int acceptableDuration, boolean fictitious, double originalValue, double limitReduction)
    Creates an instance of a ReducedTemporaryLimit record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    acceptableDuration()
    Returns the value of the acceptableDuration record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    fictitious()
    Returns the value of the fictitious record component.
    int
    getAcceptableDuration()
    Get the acceptable duration of the limit in second.
    double
    getLimitReduction()
     
    String
    getName()
    Get the temporary limit name
    double
    getOriginalValue()
     
    double
    getValue()
    Get the temporary limit value.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isFictitious()
    Check if the temporary limit is a real limit corresponding to an overloading protection or just an operating rule
    double
    limitReduction()
    Returns the value of the limitReduction record component.
    String
    name()
    Returns the value of the name record component.
    double
    originalValue()
    Returns the value of the originalValue record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ReducedTemporaryLimit

      public ReducedTemporaryLimit(String name, double value, int acceptableDuration, boolean fictitious, double originalValue, double limitReduction)
      Creates an instance of a ReducedTemporaryLimit record class.
      Parameters:
      name - the value for the name record component
      value - the value for the value record component
      acceptableDuration - the value for the acceptableDuration record component
      fictitious - the value for the fictitious record component
      originalValue - the value for the originalValue record component
      limitReduction - the value for the limitReduction record component

  • Method Details

    • getName

      public String getName()
      Description copied from interface: LoadingLimits.TemporaryLimit
      Get the temporary limit name
      Specified by:
      getName in interface LoadingLimits.TemporaryLimit
      Returns:
      the temporary limit name

    • getValue

      public double getValue()
      Description copied from interface: LoadingLimits.TemporaryLimit
      Get the temporary limit value.
      Specified by:
      getValue in interface LoadingLimits.TemporaryLimit
      Returns:
      the temporary limit value

    • getAcceptableDuration

      public int getAcceptableDuration()
      Description copied from interface: LoadingLimits.TemporaryLimit
      Get the acceptable duration of the limit in second.
      Specified by:
      getAcceptableDuration in interface LoadingLimits.TemporaryLimit
      Returns:
      the acceptable duration of the limit in second

    • isFictitious

      public boolean isFictitious()
      Description copied from interface: LoadingLimits.TemporaryLimit
      Check if the temporary limit is a real limit corresponding to an overloading protection or just an operating rule
      Specified by:
      isFictitious in interface LoadingLimits.TemporaryLimit
      Returns:
      false if it is a real limit, false otherwise

    • getOriginalValue

      public double getOriginalValue()

    • getLimitReduction

      public double getLimitReduction()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • value

      public double value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • acceptableDuration

      public int acceptableDuration()
      Returns the value of the acceptableDuration record component.
      Returns:
      the value of the acceptableDuration record component

    • fictitious

      public boolean fictitious()
      Returns the value of the fictitious record component.
      Returns:
      the value of the fictitious record component

    • originalValue

      public double originalValue()
      Returns the value of the originalValue record component.
      Returns:
      the value of the originalValue record component

    • limitReduction

      public double limitReduction()
      Returns the value of the limitReduction record component.
      Returns:
      the value of the limitReduction record component