Package gov.nasa.jpl.aerie.contrib.streamline.modeling.linear

Record Class Linear

java.lang.Object
java.lang.Record
gov.nasa.jpl.aerie.contrib.streamline.modeling.linear.Linear
All Implemented Interfaces:
Dynamics<Double,Linear>
public record Linear(Double extract, Double rate) extends Record implements Dynamics<Double,Linear>

  • Constructor Summary

    Constructors
    Constructor
    Description
    Linear(Double extract, Double rate)
    Creates an instance of a Linear record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Double
    extract()
    Returns the value of the extract record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    static Linear
    linear(double value, double rate)
     
    Double
    rate()
    Returns the value of the rate record component.
    Linear
    step(gov.nasa.jpl.aerie.merlin.protocol.types.Duration t)
    Evolve for the given time.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Linear

      public Linear(Double extract, Double rate)
      Creates an instance of a Linear record class.
      Parameters:
      extract - the value for the extract record component
      rate - the value for the rate record component

  • Method Details

    • step

      public Linear step(gov.nasa.jpl.aerie.merlin.protocol.types.Duration t)
      Description copied from interface: Dynamics
      Evolve for the given time.
      Specified by:
      step in interface Dynamics<Double,Linear>

    • linear

      public static Linear linear(double value, double rate)

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • extract

      public Double extract()
      Returns the value of the extract record component.
      Specified by:
      extract in interface Dynamics<Double,Linear>
      Returns:
      the value of the extract record component

    • rate

      public Double rate()
      Returns the value of the rate record component.
      Returns:
      the value of the rate record component