Package adams.flow.transformer.predictioncheck

Class Range

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    public class Range
extends AbstractPredictionCheck
    Ensures that the specified (numeric) evaluator results are within a specified range.
    Adds a new boolean evaluation to the container, with the same name as the checked one, but appended with the suffix '.passed'.
    E.g., when checking the evaluation 'sqr', 'sqr..passed' will get added, either with 'true' or 'false' as value. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -evaluation <java.lang.String> (property: evaluation)
    The name of the evaluation value to check.
    default:
 
    -range <adams.core.base.BaseInterval> (property: range)
    The allowed range of the numeric value of the evaluation.
    default: (-Infinity;+Infinity)
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_Evaluation
      the evaluation to check.
      protected adams.core.base.BaseInterval m_Range
      the allowed range.
      static String SUFFIX_PASSED
      the suffix for the passed flag.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      Range()  

    • Field Detail

      • m_Evaluation

        protected String m_Evaluation
        the evaluation to check.

      • m_Range

        protected adams.core.base.BaseInterval m_Range
        the allowed range.

    • Constructor Detail

      • Range

        public Range()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • setEvaluation

        public void setEvaluation​(String value)
        Sets the evaluation to check.
        Parameters:
        value - the evaluation

      • getEvaluation

        public String getEvaluation()
        Returns the evaluation to check.
        Returns:
        the evaluation

      • evaluationTipText

        public String evaluationTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setRange

        public void setRange​(adams.core.base.BaseInterval value)
        Sets the allowed range of the numeric value.
        Parameters:
        value - the range

      • getRange

        public adams.core.base.BaseInterval getRange()
        Returns the allowed range of the numeric value.
        Returns:
        the range

      • rangeTipText

        public String rangeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractPredictionCheck
        Returns:
        null if no info available, otherwise short string