Record Class ArchitecturalModel.VectorField

java.lang.Object
java.lang.Record
org.episteme.social.architecture.ArchitecturalModel.VectorField
All Implemented Interfaces:
Serializable
Enclosing class:
ArchitecturalModel
public static record ArchitecturalModel.VectorField(Real x, Real y, Real dx, Real dy, Real magnitude) extends Record implements Serializable
Represents a point in a vector field (e.g., structural force, wind velocity).
Since:
1.0
Version:
2.0
Author:
Silvere Martin-Michiellot, Gemini AI (Google DeepMind)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    VectorField(Real x, Real y, Real dx, Real dy, Real magnitude)
    Creates an instance of a VectorField record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Real
    dx()
    Returns the value of the dx record component.
    Real
    dy()
    Returns the value of the dy 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.
    Real
    magnitude()
    Returns the value of the magnitude record component.
    final String
    toString()
    Returns a string representation of this record class.
    Real
    x()
    Returns the value of the x record component.
    Real
    y()
    Returns the value of the y record component.

    Methods inherited from class Object

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

  • Constructor Details

    • VectorField

      public VectorField(Real x, Real y, Real dx, Real dy, Real magnitude)
      Creates an instance of a VectorField record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      dx - the value for the dx record component
      dy - the value for the dy record component
      magnitude - the value for the magnitude 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 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.

    • x

      public Real x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public Real y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • dx

      public Real dx()
      Returns the value of the dx record component.
      Returns:
      the value of the dx record component

    • dy

      public Real dy()
      Returns the value of the dy record component.
      Returns:
      the value of the dy record component

    • magnitude

      public Real magnitude()
      Returns the value of the magnitude record component.
      Returns:
      the value of the magnitude record component