Package com.irurueta.navigation.indoor

Class BeaconWithPower

java.lang.Object

com.irurueta.navigation.indoor.Beacon

com.irurueta.navigation.indoor.BeaconWithPower

All Implemented Interfaces:

RadioSource, RadioSourceWithPower, Serializable

Direct Known Subclasses:

BeaconWithPowerAndLocated

public class BeaconWithPower
extends Beacon
implements RadioSourceWithPower

Data related to a beacon whose transmitted power and standard deviation of such transmitted power is known.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_PATH_LOSS_EXPONENT	Default exponent typically used on free space for path loss propagation in terms of distance.
private double	pathLossExponent	Exponent typically used on free space for path loss propagation in terms of distance.
private Double	pathLossExponentStandardDeviation	Standard deviation of path loss exponent or null if unknown.
private Double	transmittedPowerStandardDeviation	Standard deviation of transmitted power value or null if unknown.

Fields inherited from class com.irurueta.navigation.indoor.Beacon

DEFAULT_FREQUENCY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BeaconWithPower()	Empty constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, double pathLossExponent)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, double frequency, double pathLossExponent, Double transmittedPowerStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, double frequency, double pathLossExponent, Double transmittedPowerStandardDeviation, Double pathLossExponentStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, double frequency, Double transmittedPowerStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, double frequency, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, double frequency, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName, double pathLossExponent)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, double frequency, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName, double pathLossExponent, Double transmittedPowerStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, double frequency, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName, double pathLossExponent, Double transmittedPowerStandardDeviation, Double pathLossExponentStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, double frequency, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName, Double transmittedPowerStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, Double transmittedPowerStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, Double transmittedPowerStandardDeviation, double pathLossExponent)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, Double transmittedPowerStandardDeviation, double pathLossExponent, Double pathLossExponentStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName, double pathLossExponent)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName, double pathLossExponent, Double transmittedPowerStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName, double pathLossExponent, Double transmittedPowerStandardDeviation, Double pathLossExponentStandardDeviation)	Constructor.
	BeaconWithPower(List<BeaconIdentifier> identifiers, double transmittedPower, String bluetoothAddress, int beaconTypeCode, int manufacturer, int serviceUuid, String bluetoothName, Double transmittedPowerStandardDeviation)	Constructor.

Method Summary

Modifier and Type	Method	Description
double	getPathLossExponent()	Gets exponent typically used on free space for path loss propagation in terms of distance.
Double	getPathLossExponentStandardDeviation()	Gets standard deviation of path loss exponent or null if unknown.
Double	getTransmittedPowerStandardDeviation()	Gets standard deviation of transmitted power value or null if unknown.

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

equals, getBeaconTypeCode, getBluetoothAddress, getBluetoothName, getFrequency, getId1, getId2, getId3, getIdentifier, getIdentifiers, getManufacturer, getServiceUuid, getTransmittedPower, getType, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.irurueta.navigation.indoor.RadioSource

equals, getFrequency, getType

Methods inherited from interface com.irurueta.navigation.indoor.RadioSourceWithPower

getTransmittedPower

Field Details

DEFAULT_PATH_LOSS_EXPONENT

public static final double DEFAULT_PATH_LOSS_EXPONENT

Default exponent typically used on free space for path loss propagation in terms of distance. This value is used for free space environments.

See Also:

• Constant Field Values

transmittedPowerStandardDeviation

private Double transmittedPowerStandardDeviation

Standard deviation of transmitted power value or null if unknown.

pathLossExponent

private double pathLossExponent

Exponent typically used on free space for path loss propagation in terms of distance. On different environments path loss exponent might have different values: - Free space: 2.0 - Urban Area: 2.7 to 3.5 - Suburban Area: 3 to 5 - Indoor (line-of-sight): 1.6 to 1.8 If path loss exponent estimation is not enabled, this value will always be equal to DEFAULT_PATH_LOSS_EXPONENT

pathLossExponentStandardDeviation

private Double pathLossExponentStandardDeviation

Standard deviation of path loss exponent or null if unknown.

Constructor Details

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 Double transmittedPowerStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null or standard deviation is negative.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName,
 Double transmittedPowerStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 double frequency,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

frequency - frequency used by this Beacon.

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 double frequency,
 Double transmittedPowerStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

frequency - frequency used by this Beacon.

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 double frequency,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName,
 Double transmittedPowerStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

frequency - frequency used by this Beacon.

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 double pathLossExponent)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

pathLossExponent - path loss exponent. By default, this is 2.0.

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName,
 double pathLossExponent)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

pathLossExponent - path loss exponent. By default, this is 2.0.

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 Double transmittedPowerStandardDeviation,
 double pathLossExponent)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

pathLossExponent - path loss exponent. By default, this is 2.0.

Throws:

IllegalArgumentException - if identifiers is null or standard deviation is negative.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName,
 double pathLossExponent,
 Double transmittedPowerStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

pathLossExponent - path loss exponent. By default, this is 2.0.

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null or standard deviation is negative.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 double frequency,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName,
 double pathLossExponent)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

frequency - frequency used by this Beacon.

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

pathLossExponent - path loss exponent. By default, this is 2.0.

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 double frequency,
 double pathLossExponent,
 Double transmittedPowerStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

frequency - frequency used by this Beacon.

pathLossExponent - path loss exponent. By default, this is 2.0.

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null or standard deviation is negative.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 double frequency,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName,
 double pathLossExponent,
 Double transmittedPowerStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

frequency - frequency used by this Beacon.

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

pathLossExponent - path loss exponent. By default, this is 2.0.

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null or standard deviation is negative.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 Double transmittedPowerStandardDeviation,
 double pathLossExponent,
 Double pathLossExponentStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

pathLossExponent - path loss exponent. By default, this is 2.0.

pathLossExponentStandardDeviation - standard deviation of path loss exponent or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null or any standard deviation is negative.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName,
 double pathLossExponent,
 Double transmittedPowerStandardDeviation,
 Double pathLossExponentStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

pathLossExponent - path loss exponent. By default, this is 2.0.

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

pathLossExponentStandardDeviation - standard deviation of path loss exponent or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null or any standard deviation is negative.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 double frequency,
 double pathLossExponent,
 Double transmittedPowerStandardDeviation,
 Double pathLossExponentStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

frequency - frequency used by this Beacon.

pathLossExponent - path loss exponent. By default, this is 2.0.

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

pathLossExponentStandardDeviation - standard deviation of path loss exponent or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null or any standard deviation is negative.

BeaconWithPower

public BeaconWithPower(List<BeaconIdentifier> identifiers,
 double transmittedPower,
 double frequency,
 String bluetoothAddress,
 int beaconTypeCode,
 int manufacturer,
 int serviceUuid,
 String bluetoothName,
 double pathLossExponent,
 Double transmittedPowerStandardDeviation,
 Double pathLossExponentStandardDeviation)

Constructor.

Parameters:

identifiers - list of the multipart identifiers of the beacon.

transmittedPower - calibrated measured Tx power of the Beacon in RSSI (expressed in dBm's).

frequency - frequency used by this Beacon.

bluetoothAddress - the bluetooth mac address.

beaconTypeCode - the two byte value indicating the type of beacon.

manufacturer - a two byte code indicating the beacon manufacturer.

serviceUuid - a 32 bit service uuid for the beacon.

bluetoothName - the bluetooth device name.

pathLossExponent - path loss exponent. By default, this is 2.0.

transmittedPowerStandardDeviation - standard deviation of transmitted power value or null if unknown.

pathLossExponentStandardDeviation - standard deviation of path loss exponent or null if unknown.

Throws:

IllegalArgumentException - if identifiers is null.

BeaconWithPower

protected BeaconWithPower()

Empty constructor.

Method Details

getTransmittedPowerStandardDeviation

public Double getTransmittedPowerStandardDeviation()

Gets standard deviation of transmitted power value or null if unknown.

Specified by:

getTransmittedPowerStandardDeviation in interface RadioSourceWithPower

Returns:

standard deviation of transmitted power value or null if unknown.

getPathLossExponent

public double getPathLossExponent()

Gets exponent typically used on free space for path loss propagation in terms of distance. On different environments path loss exponent might have different values: - Free space: 2.0 - Urban Area: 2.7 to 3.5 - Suburban Area: 3 to 5 - Indoor (line-of-sight): 1.6 to 1.8 If path loss exponent estimation is not enabled, this value will always be equal to DEFAULT_PATH_LOSS_EXPONENT

Specified by:

getPathLossExponent in interface RadioSourceWithPower

Returns:

path loss exponent.

getPathLossExponentStandardDeviation

public Double getPathLossExponentStandardDeviation()

Gets standard deviation of path loss exponent or null if unknown.

Specified by:

getPathLossExponentStandardDeviation in interface RadioSourceWithPower

Returns:

standard deviation of path loss exponent or null if unknown.