Record Class NumericAttributeVariationAxis

java.lang.Object
java.lang.Record
com.amalgamasimulation.studies.core.NumericAttributeVariationAxis

public record NumericAttributeVariationAxis(String typeName, String fieldName, boolean absolute, double minValue, double maxValue, double step, List<String> objectIdentifiers) extends Record
Represents a variation axis for a numeric attribute in a simulation study. This axis defines a sequence of values between the minimum and the maximum, spaced by the step, for applying changes to a specific numeric field of EMF data model objects.

The variation can be either:

  • Absolute: The values generated by this axis directly replace the attribute's value.
  • Relative: The values are treated as multipliers (e.g., 1.1 = +10%) applied to the attribute’s base value.
Author:
Andrey Malykhanov
  • Constructor Summary

    Constructors
    Constructor
    Description
    NumericAttributeVariationAxis(String typeName, String fieldName, boolean absolute, double minValue, double maxValue, double step, List<String> objectIdentifiers)
    Creates an instance of a NumericAttributeVariationAxis record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Returns the value of the absolute record component.
    Returns a human-readable description of the variation axis.
    final boolean
    Indicates whether some other object is "equal to" this one.
    Returns the value of the fieldName record component.
    final int
    Returns a hash code value for this object.
    double
    Returns the value of the maxValue record component.
    double
    Returns the value of the minValue record component.
    Returns the value of the objectIdentifiers record component.
    double
    Returns the value of the step record component.
    final String
    Returns a string representation of this record class.
    Returns the value of the typeName record component.
    Returns the list of values to apply to the target attribute.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • NumericAttributeVariationAxis

      public NumericAttributeVariationAxis(String typeName, String fieldName, boolean absolute, double minValue, double maxValue, double step, List<String> objectIdentifiers)
      Creates an instance of a NumericAttributeVariationAxis record class.
      Parameters:
      typeName - the value for the typeName record component
      fieldName - the value for the fieldName record component
      absolute - the value for the absolute record component
      minValue - the value for the minValue record component
      maxValue - the value for the maxValue record component
      step - the value for the step record component
      objectIdentifiers - the value for the objectIdentifiers record component
  • Method Details

    • values

      public List<Double> values()
      Returns the list of values to apply to the target attribute.
      Returns:
      a list of double values representing the variation axis
    • description

      public String description()
      Returns a human-readable description of the variation axis.
      Returns:
      a string such as "Absolute variation of setupDuration of DrillingMachineType"
    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.
    • typeName

      public String typeName()
      Returns the value of the typeName record component.
      Returns:
      the value of the typeName record component
    • fieldName

      public String fieldName()
      Returns the value of the fieldName record component.
      Returns:
      the value of the fieldName record component
    • absolute

      public boolean absolute()
      Returns the value of the absolute record component.
      Returns:
      the value of the absolute record component
    • minValue

      public double minValue()
      Returns the value of the minValue record component.
      Returns:
      the value of the minValue record component
    • maxValue

      public double maxValue()
      Returns the value of the maxValue record component.
      Returns:
      the value of the maxValue record component
    • step

      public double step()
      Returns the value of the step record component.
      Returns:
      the value of the step record component
    • objectIdentifiers

      public List<String> objectIdentifiers()
      Returns the value of the objectIdentifiers record component.
      Returns:
      the value of the objectIdentifiers record component