Enum Class TimeOfFlight.Status

java.lang.Object
java.lang.Enum<TimeOfFlight.Status>
com.playingwithfusion.TimeOfFlight.Status
All Implemented Interfaces:
Serializable, Comparable<TimeOfFlight.Status>, Constable
Enclosing class:
TimeOfFlight

public static enum TimeOfFlight.Status extends Enum<TimeOfFlight.Status>
Distance measurement status
  • Enum Constant Details

    • Valid

      public static final TimeOfFlight.Status Valid
      Measured distance is valid
    • SigmaHigh

      public static final TimeOfFlight.Status SigmaHigh
      Sigma estimator check is above internally defined threshold. The repeatability or standard deviation of the measurement is bad due to a decreasing signal noise ratio. Increasing the timing budget can improve the standard deviation.
    • ReturnSignalLow

      public static final TimeOfFlight.Status ReturnSignalLow
      Return signal value is below the internal defined threshold. The return signal is too week to return a good answer. The target may be too far, not reflective enough, or too small. Increasing the timing buget might help, but there may simply be no target available.
    • ReturnPhaseBad

      public static final TimeOfFlight.Status ReturnPhaseBad
      Return signal phase is out of bounds. This means that the sensor is ranging in a "nonappropriated" zone and the measured result may be inconsistent. This status is considered as a warning but, in general, it happens when a target is at the maximum distance possible from the sensor.
    • HardwareFailure

      public static final TimeOfFlight.Status HardwareFailure
      Hardware failure
    • WrappedTarget

      public static final TimeOfFlight.Status WrappedTarget
      Wrapped target, non-matching phases. This situation may occur when the target is very reflective and the distance to the target/sensor is longer than the physical limited distance measurable by the sensor. For example, approximately 5m when the senor is in Long distance mode and approximately 1.3 m when the sensor is in Short distance mode.
    • InternalError

      public static final TimeOfFlight.Status InternalError
      Internal algorithm underflow or overflow
    • Invalid

      public static final TimeOfFlight.Status Invalid
      The measured distance is invalid
  • Method Details

    • values

      public static TimeOfFlight.Status[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static TimeOfFlight.Status valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null