Package org.cha0scollective.wwpg.api

Record Class ElectricalModel.Inductor

java.lang.Object
java.lang.Record
org.cha0scollective.wwpg.api.ElectricalModel.Inductor
All Implemented Interfaces:
ElectricalModel
Enclosing interface:
ElectricalModel
public static record ElectricalModel.Inductor(double inductanceHenries, double initialCurrentAmps) extends Record implements ElectricalModel
Ideal inductor integrated by backward Euler, without implicit series resistance. initialCurrentAmps initializes reconstructed state only, from positive to negative.

  • Constructor Details

    • Inductor

      public Inductor(double inductanceHenries, double initialCurrentAmps)
      Creates an instance of a Inductor record class.
      Parameters:
      inductanceHenries - the value for the inductanceHenries record component
      initialCurrentAmps - the value for the initialCurrentAmps 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. All components in this record class 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.

    • inductanceHenries

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

    • initialCurrentAmps

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