com.estimote.coresdk.recognition.packets

Class Beacon

java.lang.Object

com.estimote.coresdk.recognition.packets.Packet

com.estimote.coresdk.recognition.packets.Beacon

All Implemented Interfaces:

android.os.Parcelable

public class Beacon
extends Packet

Immutable representations of single beacon.

Two beacons are considered equal if their location UUID, major and minor are equal.

Author:

Wiktor Gworek (wiktor@estimote.com)

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<Beacon>	CREATOR

Fields inherited from class com.estimote.coresdk.recognition.packets.Packet

packetType

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Beacon(java.util.UUID proximityUUID, MacAddress macAddress, int major, int minor, int measuredPower, int rssi)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object o)
MacAddress	getMacAddress()
int	getMajor()
int	getMeasuredPower()
int	getMinor()
java.util.UUID	getProximityUUID()
int	getRssi()
java.lang.String	getUniqueKey() Returns unique key for this packet to identify it between other Packet objects.
int	hashCode()
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.estimote.coresdk.recognition.packets.Packet

getPacketType

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<Beacon> CREATOR

Constructor Detail

Beacon

public Beacon(java.util.UUID proximityUUID,
              MacAddress macAddress,
              int major,
              int minor,
              int measuredPower,
              int rssi)

Method Detail

getProximityUUID

public java.util.UUID getProximityUUID()

Returns:

Location UUID of the beacon in format XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (all lowercases).

getMacAddress

public MacAddress getMacAddress()

Returns:

MAC address of the beacon.

getMajor

public int getMajor()

Returns:

Major version of the beacon.

getMinor

public int getMinor()

Returns:

Minor version of the beacon.

getMeasuredPower

public int getMeasuredPower()

Returns:

Measured transmitPower of the beacon (in dBm).

getRssi

public int getRssi()

Returns:

Received Signal Strength Indication at the moment of scanning.

getUniqueKey

public java.lang.String getUniqueKey()

Description copied from class: Packet

Returns unique key for this packet to identify it between other Packet objects. Child classes should implement this method.

Specified by:

getUniqueKey in class Packet

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class Packet