Record Class SlimPhosphorusFunctions.UptakeResult

java.lang.Object
java.lang.Record
net.simplace.sim.components.experimental.slim.SlimPhosphorusFunctions.UptakeResult
Enclosing class:
SlimPhosphorusFunctions

public static record SlimPhosphorusFunctions.UptakeResult(Double[] Uptake, double TotalUptake, Double[] Dissolved) extends Record
  • Constructor Summary

    Constructors
    Constructor
    Description
    UptakeResult(Double[] Uptake, double TotalUptake, Double[] Dissolved)
    Creates an instance of a UptakeResult record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the Dissolved record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    final String
    Returns a string representation of this record class.
    double
    Returns the value of the TotalUptake record component.
    Returns the value of the Uptake record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • UptakeResult

      public UptakeResult(Double[] Uptake, double TotalUptake, Double[] Dissolved)
      Creates an instance of a UptakeResult record class.
      Parameters:
      Uptake - the value for the Uptake record component
      TotalUptake - the value for the TotalUptake record component
      Dissolved - the value for the Dissolved record component
  • Method Details

    • 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.
    • Uptake

      public Double[] Uptake()
      Returns the value of the Uptake record component.
      Returns:
      the value of the Uptake record component
    • TotalUptake

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

      public Double[] Dissolved()
      Returns the value of the Dissolved record component.
      Returns:
      the value of the Dissolved record component