Module simpa.core
Package simpa.core.api.track

Record Class PhaseSpaceCoordinates

java.lang.Object
java.lang.Record
simpa.core.api.track.PhaseSpaceCoordinates
Record Components:
x -
xp -
y -
yp -
z -
zp -
public record PhaseSpaceCoordinates(double x, double xp, double y, double yp, double z, double zp) extends Record
Non-mutable record for representing the phase space coordinates of a particle. This usually created by some observer object added to the ParticleTrackerTask. Creates an instance of PhaseSpaceCoordinates. The actual meaning of the phase space coordinates depend on the application. For example in accelerators the Z coordinate can be the time delay compared to the reference particle, but in plasma simulation it might be simply the Cartesian Z coordinate.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PhaseSpaceCoordinates(double x, double xp, double y, double yp, double z, double zp)
    Creates an instance of a PhaseSpaceCoordinates record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    String
    toString()
    Returns a string representation of this record class.
    double
    x()
    Returns the value of the x record component.
    double
    xp()
    Returns the value of the xp record component.
    double
    y()
    Returns the value of the y record component.
    double
    yp()
    Returns the value of the yp record component.
    double
    z()
    Returns the value of the z record component.
    double
    zp()
    Returns the value of the zp record component.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PhaseSpaceCoordinates

      public PhaseSpaceCoordinates(double x, double xp, double y, double yp, double z, double zp)
      Creates an instance of a PhaseSpaceCoordinates record class.
      Parameters:
      x - the value for the x record component
      xp - the value for the xp record component
      y - the value for the y record component
      yp - the value for the yp record component
      z - the value for the z record component
      zp - the value for the zp record component

  • Method Details

    • toString

      public 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.

    • x

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

    • xp

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

    • y

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

    • yp

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

    • z

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

    • zp

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