Package gov.nasa.jpl.aerie.scheduler.simulation

Record Class SimulationFacade.PlanSimCorrespondence

java.lang.Object
java.lang.Record
gov.nasa.jpl.aerie.scheduler.simulation.SimulationFacade.PlanSimCorrespondence
Enclosing interface:
SimulationFacade
public static record SimulationFacade.PlanSimCorrespondence(Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirective> directiveIdActivityDirectiveMap) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlanSimCorrespondence(Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirective> directiveIdActivityDirectiveMap)
    Creates an instance of a PlanSimCorrespondence record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirective>
    directiveIdActivityDirectiveMap()
    Returns the value of the directiveIdActivityDirectiveMap record component.
    boolean
    equals(Object other)
    Indicates whether some other object is "equal to" this one.
    Optional<Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId>>
    equalsWithIdMap(SimulationFacade.PlanSimCorrespondence other)
    Performs an ID-agnostic equals check, but also generates a transformation for IDs that do not match between the two plans.
    final int
    hashCode()
    Returns a hash code value for this object.
    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

    • PlanSimCorrespondence

      public PlanSimCorrespondence(Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirective> directiveIdActivityDirectiveMap)
      Creates an instance of a PlanSimCorrespondence record class.
      Parameters:
      directiveIdActivityDirectiveMap - the value for the directiveIdActivityDirectiveMap record component

  • Method Details

    • equals

      public boolean equals(Object other)
      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:
      other - the object with which to compare
      Returns:
      true if this object is the same as the other argument; false otherwise.

    • equalsWithIdMap

      public Optional<Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId>> equalsWithIdMap(SimulationFacade.PlanSimCorrespondence other)
      Performs an ID-agnostic equals check, but also generates a transformation for IDs that do not match between the two plans. This function is anti-symmetric; `a.equalsWithIdMap(b)` will return a map from `a` ids to `b` ids, which is the reverse of `b.equalsWithIdMap(a)`.
      Returns:
      Either `Optional.empty` if the plans are not equal, or `Optional.of(map)` if they are equal, where `map` contains a mapping between *only the IDs that are different* between the two plans.

    • 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

    • directiveIdActivityDirectiveMap

      public Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirective> directiveIdActivityDirectiveMap()
      Returns the value of the directiveIdActivityDirectiveMap record component.
      Returns:
      the value of the directiveIdActivityDirectiveMap record component