Record Class SolarPathAnalyzer.InsolationResult

java.lang.Object
java.lang.Record
org.episteme.social.architecture.SolarPathAnalyzer.InsolationResult
All Implemented Interfaces:
Serializable
Enclosing class:
SolarPathAnalyzer
public static record SolarPathAnalyzer.InsolationResult(double dailyTotal, double[] hourlyValues, double peakHour, double peakValue) extends Record implements Serializable
Results of a 24-hour solar insulation simulation.
Since:
1.0
Version:
2.0
Author:
Silvere Martin-Michiellot, Gemini AI (Google DeepMind)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    InsolationResult(double dailyTotal, double[] hourlyValues, double peakHour, double peakValue)
    Creates an instance of a InsolationResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    dailyTotal()
    Returns the value of the dailyTotal record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    double[]
    hourlyValues()
    Returns the value of the hourlyValues record component.
    double
    peakHour()
    Returns the value of the peakHour record component.
    double
    peakValue()
    Returns the value of the peakValue record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • InsolationResult

      public InsolationResult(double dailyTotal, double[] hourlyValues, double peakHour, double peakValue)
      Creates an instance of a InsolationResult record class.
      Parameters:
      dailyTotal - the value for the dailyTotal record component
      hourlyValues - the value for the hourlyValues record component
      peakHour - the value for the peakHour record component
      peakValue - the value for the peakValue 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 the compare method from their corresponding wrapper classes.
      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.

    • dailyTotal

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

    • hourlyValues

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

    • peakHour

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

    • peakValue

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