Record Class ARI1ParameterDescriptionReal

java.lang.Object
java.lang.Record
com.io7m.aradine.instrument.spi1.ARI1ParameterDescriptionReal
Record Components:
id - The parameter ID
label - The parameter label
documentation - The parameter documentation
unitOfMeasurement - The unit of measurement for the parameter
valueMinimum - The minimum value (inclusive)
valueMaximum - The maximum value (inclusive)
valueDefault - The default value
All Implemented Interfaces:
ARI1DocumentedType, ARI1ParameterDescriptionType
public record ARI1ParameterDescriptionReal(ARI1ParameterNumber id, String label, Optional<ARI1Documentation> documentation, ARI1DottedName unitOfMeasurement, double valueMinimum, double valueMaximum, double valueDefault) extends Record implements ARI1ParameterDescriptionType

A real-typed parameter description.

  • Constructor Details

    • ARI1ParameterDescriptionReal

      public ARI1ParameterDescriptionReal(ARI1ParameterNumber id, String label, Optional<ARI1Documentation> documentation, ARI1DottedName unitOfMeasurement, double valueMinimum, double valueMaximum, double valueDefault)

      A real-typed parameter description.

      Parameters:
      id - The parameter ID
      label - The parameter label
      documentation - The parameter documentation
      unitOfMeasurement - The unit of measurement for the parameter
      valueMinimum - The minimum value (inclusive)
      valueMaximum - The maximum value (inclusive)
      valueDefault - The default value

  • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • id

      public ARI1ParameterNumber id()
      Returns the value of the id record component.
      Specified by:
      id in interface ARI1ParameterDescriptionType
      Returns:
      the value of the id record component

    • label

      public String label()
      Returns the value of the label record component.
      Specified by:
      label in interface ARI1ParameterDescriptionType
      Returns:
      the value of the label record component

    • documentation

      public Optional<ARI1Documentation> documentation()
      Returns the value of the documentation record component.
      Specified by:
      documentation in interface ARI1DocumentedType
      Returns:
      the value of the documentation record component

    • unitOfMeasurement

      public ARI1DottedName unitOfMeasurement()
      Returns the value of the unitOfMeasurement record component.
      Returns:
      the value of the unitOfMeasurement record component

    • valueMinimum

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

    • valueMaximum

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

    • valueDefault

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