Class RangingReadingLocated<S extends RadioSource,P extends com.irurueta.geometry.Point<?>>

java.lang.Object
com.irurueta.navigation.indoor.Reading<S>
com.irurueta.navigation.indoor.RangingReading<S>
com.irurueta.navigation.indoor.RangingReadingLocated<S,P>
Type Parameters:
S - a RadioSource type.
P - a Point type.
All Implemented Interfaces:
ReadingLocated<P>, Serializable
Direct Known Subclasses:
RangingReadingLocated2D, RangingReadingLocated3D

public class RangingReadingLocated<S extends RadioSource,P extends com.irurueta.geometry.Point<?>> extends RangingReading<S> implements ReadingLocated<P>
Contains a located ranging reading associated to a given radio source (e.g. Wi-Fi access point or bluetooth beacon), indicating the distance to such access point.
See Also:
  • Field Details

    • position

      private P extends com.irurueta.geometry.Point<?> position
      Position where Wi-Fi reading was made.
    • positionCovariance

      private com.irurueta.algebra.Matrix positionCovariance
      Covariance of inhomogeneous coordinates of current position (if available).
  • Constructor Details

    • RangingReadingLocated

      public RangingReadingLocated(S source, double distance, P position)
      Constructor.
      Parameters:
      source - radio source associated to this reading.
      distance - distance in meters to the radio source.
      position - position where reading was made.
      Throws:
      IllegalArgumentException - if radio source data is null, distance is negative or position is null.
    • RangingReadingLocated

      public RangingReadingLocated(S source, double distance, P position, int numAttemptedMeasurements, int numSuccessfulMeasurements)
      Constructor.
      Parameters:
      source - radio source associated to this reading.
      distance - distance in meters to the radio source.
      position - position where reading was made.
      numAttemptedMeasurements - number of attempted measurements used in the RTT exchange.
      numSuccessfulMeasurements - number of successful measurements used to calculate the distance and standard deviation.
      Throws:
      IllegalArgumentException - if radio source data is null, distance is negative, position is null, number of attempted measures is less than 1 or number of successful measures is negative.
    • RangingReadingLocated

      public RangingReadingLocated(S source, double distance, P position, Double distanceStandardDeviation)
      Constructor.
      Parameters:
      source - radio source associated to this reading.
      distance - distance in meters to the radio source.
      position - position where reading was made.
      distanceStandardDeviation - standard deviation of distance, if available.
      Throws:
      IllegalArgumentException - if radio source data is null, distance is negative, position is null or standard deviation is zero or negative.
    • RangingReadingLocated

      public RangingReadingLocated(S source, double distance, P position, Double distanceStandardDeviation, int numAttemptedMeasurements, int numSuccessfulMeasurements)
      Constructor.
      Parameters:
      source - radio source associated to this reading.
      distance - distance in meters to the radio source.
      position - position where reading was made.
      distanceStandardDeviation - standard deviation of distance, if available.
      numAttemptedMeasurements - number of attempted measurements used in the RTT exchange.
      numSuccessfulMeasurements - number of successful measurements used to calculate the distance and standard deviation.
      Throws:
      IllegalArgumentException - if radio source data is null, distance is negative, position is null or standard deviation is zero or negative, number of attempted measures is less than 1 or number of successful measures is negative.
    • RangingReadingLocated

      public RangingReadingLocated(S source, double distance, P position, com.irurueta.algebra.Matrix positionCovariance)
      Constructor.
      Parameters:
      source - radio source associated to this reading.
      distance - distance in meters to the radio source.
      position - position where reading was made.
      positionCovariance - covariance of inhomogeneous coordinates of current position (if available).
      Throws:
      IllegalArgumentException - if radio source data is null, distance is negative, position is null or position covariance has wrong size.
    • RangingReadingLocated

      public RangingReadingLocated(S source, double distance, P position, com.irurueta.algebra.Matrix positionCovariance, int numAttemptedMeasurements, int numSuccessfulMeasurements)
      Constructor.
      Parameters:
      source - radio source associated to this reading.
      distance - distance in meters to the radio source.
      position - position where reading was made.
      positionCovariance - covariance of inhomogeneous coordinates of current position (if available).
      numAttemptedMeasurements - number of attempted measurements used in the RTT exchange.
      numSuccessfulMeasurements - number of successful measurements used to calculate the distance and standard deviation.
      Throws:
      IllegalArgumentException - if radio source data is null, distance is negative, position is null, position covariance has wrong size, number of attempted measures is less than 1 or number of successful measures is negative.
    • RangingReadingLocated

      public RangingReadingLocated(S source, double distance, P position, Double distanceStandardDeviation, com.irurueta.algebra.Matrix positionCovariance)
      Constructor.
      Parameters:
      source - radio source associated to this reading.
      distance - distance in meters to the radio source.
      position - position where reading was made.
      distanceStandardDeviation - standard deviation of distance, if available.
      positionCovariance - covariance of inhomogeneous coordinates of current position (if available).
      Throws:
      IllegalArgumentException - if radio source data is null, distance is negative, position is null or standard deviation is zero or negative.
    • RangingReadingLocated

      public RangingReadingLocated(S source, double distance, P position, Double distanceStandardDeviation, com.irurueta.algebra.Matrix positionCovariance, int numAttemptedMeasurements, int numSuccessfulMeasurements)
      Constructor.
      Parameters:
      source - radio source associated to this reading.
      distance - distance in meters to the radio source.
      position - position where reading was made.
      distanceStandardDeviation - standard deviation of distance, if available.
      positionCovariance - covariance of inhomogeneous coordinates of current position (if available).
      numAttemptedMeasurements - number of attempted measurements used in the RTT exchange.
      numSuccessfulMeasurements - number of successful measurements used to calculate the distance and standard deviation.
      Throws:
      IllegalArgumentException - if radio source data is null, distance is negative, position is null, distance standard deviation is zero or negative, position covariance has wrong size, number of attempted measures is less than 1 or number of successful measures is negative.
    • RangingReadingLocated

      protected RangingReadingLocated()
      Empty constructor.
  • Method Details

    • getPosition

      public P getPosition()
      Gets position where reading was made.
      Specified by:
      getPosition in interface ReadingLocated<S extends RadioSource>
      Returns:
      position where reading was made.
    • getPositionCovariance

      public com.irurueta.algebra.Matrix getPositionCovariance()
      Gets covariance of inhomogeneous coordinates of current position (if available).
      Specified by:
      getPositionCovariance in interface ReadingLocated<S extends RadioSource>
      Returns:
      covariance of position or null.