Package com.irurueta.navigation.indoor

Class RangingReading<S extends RadioSource>

java.lang.Object

com.irurueta.navigation.indoor.Reading<S>

com.irurueta.navigation.indoor.RangingReading<S>

Type Parameters:

S - a RadioSource type.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RangingReadingLocated

public class RangingReading<S extends RadioSource>
extends Reading<S>

Contains a ranging reading associated to a given radio source (e.g. Wi-Fi access point or bluetooth beacon), indicating the distance to such source.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_NUM_MEASUREMENTS	Default number of measurements.
private double	distance	Distance in meters to the radio source.
private Double	distanceStandardDeviation	Standard deviation of distance, if available.
private int	numAttemptedMeasurements	Number of attempted measurements used in the RTT exchange.
private int	numSuccessfulMeasurements	Number of successful measurements used to calculate the distance and standard deviation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RangingReading()	Empty constructor.
	RangingReading(S source, double distance)	Constructor.
	RangingReading(S source, double distance, int numAttemptedMeasurements, int numSuccessfulMeasurements)	Constructor.
	RangingReading(S source, double distance, Double distanceStandardDeviation)	Constructor.
	RangingReading(S source, double distance, Double distanceStandardDeviation, int numAttemptedMeasurements, int numSuccessfulMeasurements)	Constructor.

Method Summary

Modifier and Type	Method	Description
double	getDistance()	Gets distance in meters to the radio source.
Double	getDistanceStandardDeviation()	Gets standard deviation of distance, if available.
int	getNumAttemptedMeasurements()	Gets number of attempted measurements used in the RTT exchange.
int	getNumSuccessfulMeasurements()	Gets number of successful measurements used to calculate the distance and standard deviation.
ReadingType	getType()	Contains radio source reading type.

Methods inherited from class com.irurueta.navigation.indoor.Reading

getSource, hasSameSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_NUM_MEASUREMENTS

public static final int DEFAULT_NUM_MEASUREMENTS

Default number of measurements.

See Also:

• Constant Field Values

distance

private double distance

Distance in meters to the radio source.

distanceStandardDeviation

private Double distanceStandardDeviation

Standard deviation of distance, if available.

numAttemptedMeasurements

private int numAttemptedMeasurements

Number of attempted measurements used in the RTT exchange.

numSuccessfulMeasurements

private int numSuccessfulMeasurements

Number of successful measurements used to calculate the distance and standard deviation.

Constructor Details

RangingReading

public RangingReading(S source,
 double distance)

Constructor.

Parameters:

source - radio source associated to this reading.

distance - distance in meters to the radio source.

Throws:

IllegalArgumentException - if radio source data is null or distance is negative.

RangingReading

public RangingReading(S source,
 double distance,
 int numAttemptedMeasurements,
 int numSuccessfulMeasurements)

Constructor.

Parameters:

source - radio source associated to this reading.

distance - distance in meters to the radio source.

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, number of attempted measures is less than 1 or number of successful measures is negative.

RangingReading

public RangingReading(S source,
 double distance,
 Double distanceStandardDeviation)

Constructor.

Parameters:

source - radio source associated to this reading.

distance - distance in meters to the radio source.

distanceStandardDeviation - standard deviation of distance, if available.

Throws:

IllegalArgumentException - if radio source data is null, distance is negative or standard deviation is zero or negative.

RangingReading

public RangingReading(S source,
 double distance,
 Double distanceStandardDeviation,
 int numAttemptedMeasurements,
 int numSuccessfulMeasurements)

Constructor.

Parameters:

source - radio source associated to this reading.

distance - distance in meters to the radio source.

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 or standard deviation is zero or negative, number of attempted measures is less than 1 or number of successful measures is negative.

RangingReading

protected RangingReading()

Empty constructor.

Method Details

getType

public ReadingType getType()

Contains radio source reading type.

Specified by:

getType in class Reading<S extends RadioSource>

Returns:

reading type.

getDistance

public double getDistance()

Gets distance in meters to the radio source.

Returns:

distance in meters to the radio source.

getDistanceStandardDeviation

public Double getDistanceStandardDeviation()

Gets standard deviation of distance, if available.

Returns:

standard deviation of distance or null.

getNumAttemptedMeasurements

public int getNumAttemptedMeasurements()

Gets number of attempted measurements used in the RTT exchange.

Returns:

number of attempted measurements used in the RTT exchange.

getNumSuccessfulMeasurements

public int getNumSuccessfulMeasurements()

Gets number of successful measurements used to calculate the distance and standard deviation.

Returns:

number of successful measurements used to calculate the distance and standard deviation.