Class Filter

    • Constructor Summary

      Constructors 
      Constructor Description
      Filter​(PIDSource source)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      abstract double get()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the current filter estimate without also inserting new data as pidGet() would do.
      PIDSourceType getPIDSourceType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get which parameter of the device you are using as a process control variable.
      abstract double pidGet()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the result to use in PIDController.
      protected double pidGetSource()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Calls PIDGet() of source.
      abstract void reset()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reset the filter state.
      void setPIDSourceType​(PIDSourceType pidSource)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set which parameter of the device you are using as a process control variable.
    • Constructor Detail

      • Filter

        public Filter​(PIDSource source)
        Deprecated, for removal: This API element is subject to removal in a future version.
    • Method Detail

      • setPIDSourceType

        public void setPIDSourceType​(PIDSourceType pidSource)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: PIDSource
        Set which parameter of the device you are using as a process control variable.
        Specified by:
        setPIDSourceType in interface PIDSource
        Parameters:
        pidSource - An enum to select the parameter.
      • getPIDSourceType

        public PIDSourceType getPIDSourceType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: PIDSource
        Get which parameter of the device you are using as a process control variable.
        Specified by:
        getPIDSourceType in interface PIDSource
        Returns:
        the currently selected PID source parameter
      • pidGet

        public abstract double pidGet()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: PIDSource
        Get the result to use in PIDController.
        Specified by:
        pidGet in interface PIDSource
        Returns:
        the result to use in PIDController
      • get

        public abstract double get()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the current filter estimate without also inserting new data as pidGet() would do.
        Returns:
        The current filter estimate
      • reset

        public abstract void reset()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Reset the filter state.
      • pidGetSource

        protected double pidGetSource()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Calls PIDGet() of source.
        Returns:
        Current value of source