Class navXPIDController.PIDResult

  • Enclosing class:
    navXPIDController

    public static class navXPIDController.PIDResult
    extends java.lang.Object
    The PIDResult class encapsulates the data used by the navXPIDController to communicate current state to a client of the navXPIDController. The client creates the instance of the PIDResult, and continually provides it to the navxPIDController's waitForNewUpdate() and isNewDataAvailable() methods, depending upon whether the client wishes to block (wait) for new updates, or periodically poll to determine when new data is available.
    • Constructor Summary

      Constructors 
      Constructor Description
      PIDResult()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getOutput()
      Returns the output value calculated by the navXPIDController which corresponds to the most recent input data sample.
      long getTimestamp()
      Returns the timestamp of the last data sample processed by the navXPIDController.
      boolean isOnTarget()
      Returns true if the navXPIDController indicated that it is currently "on target" as defined by the configured tolerances and the most recent input data sample.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • output

        public double output
      • timestamp

        public long timestamp
      • on_target

        public boolean on_target
    • Constructor Detail

      • PIDResult

        public PIDResult()
    • Method Detail

      • getTimestamp

        public long getTimestamp()
        Returns the timestamp of the last data sample processed by the navXPIDController.
      • isOnTarget

        public boolean isOnTarget()
        Returns true if the navXPIDController indicated that it is currently "on target" as defined by the configured tolerances and the most recent input data sample.
      • getOutput

        public double getOutput()
        Returns the output value calculated by the navXPIDController which corresponds to the most recent input data sample.