Package uk.ac.warwick.dcs.sherlock.api.annotation

Class AdjustableParameterObj

  • public class AdjustableParameterObj
extends java.lang.Object
    An object to wrap an adjustable parameter annotation with other information commonly required when working with it

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      float getDefaultValue()
      Default value the parameter takes
      java.lang.String getDescription()
      Optional, detailed description of what the parameter does
      java.lang.String getDisplayName()
      Display Name for the parameter to be displayed in the UI
      float getMaximumBound()
      The maximum bound for the field
      float getMinimumBound()
      Minimum bound for field
      java.lang.String getName()
      Field Name for the parameter for use in the UI backend
      java.lang.String getReference()
      Fetches the reference string for the adjustable parameter represented by this object
      float getStep()
      The step to increment or decrement the parameter by in the UI
      boolean isFixed()
      Return if the parameter is fixed, ie.
      boolean isInt()
      is the parameter an integer parameter? (if not is a float)

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AdjustableParameterObj

        public AdjustableParameterObj​(AdjustableParameter param,
                              java.lang.reflect.Field field,
                              boolean isFixed)

    • Method Detail

      • getDefaultValue

        public float getDefaultValue()
        Default value the parameter takes
        Returns:
        the default value

      • getDescription

        public java.lang.String getDescription()
        Optional, detailed description of what the parameter does
        Returns:
        the description string

      • getDisplayName

        public java.lang.String getDisplayName()
        Display Name for the parameter to be displayed in the UI
        Returns:
        the display name

      • getMaximumBound

        public float getMaximumBound()
        The maximum bound for the field
        Returns:
        the max bound

      • getMinimumBound

        public float getMinimumBound()
        Minimum bound for field
        Returns:
        the min bound

      • getName

        public java.lang.String getName()
        Field Name for the parameter for use in the UI backend
        Returns:
        backend name

      • getReference

        public java.lang.String getReference()
        Fetches the reference string for the adjustable parameter represented by this object
        Returns:
        the parameter specific string

      • getStep

        public float getStep()
        The step to increment or decrement the parameter by in the UI
        Returns:
        the step value

      • isFixed

        public boolean isFixed()
        Return if the parameter is fixed, ie. it cannot be modified after a task has been run, for example when it is for a detector
        Returns:
        is the param fixed after raw results have been generated?

      • isInt

        public boolean isInt()
        is the parameter an integer parameter? (if not is a float)
        Returns:
        is an integer?