org.altbeacon.beacon

Class AltBeacon

java.lang.Object

org.altbeacon.beacon.Beacon

org.altbeacon.beacon.AltBeacon

All Implemented Interfaces:

Parcelable, Serializable

public class AltBeacon
extends Beacon

The AltBeacon class represents a single hardware AltBeacon detected by an Android device. It is more specific than the Beacon class in that it provides access to the #mfgReserved field.

An AltBeacon is identified by a unique three part identifier. The first identifier Id1 is normally used across an organization, the second identifier Id2 is used to group beacons and the third identifier Id3 is used to uniquely identify a specific beacon (in combination with the other two identifiers.)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AltBeacon.Builder Builder class for AltBeacon objects.

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<AltBeacon>	CREATOR Required for making object Parcelable.

Fields inherited from class org.altbeacon.beacon.Beacon

beaconDataFactory, mBeaconTypeCode, mBluetoothAddress, mBluetoothName, mDataFields, mDistance, mExtraDataFields, mFirstCycleDetectionTimestamp, mIdentifiers, mLastCycleDetectionTimestamp, mManufacturer, mMultiFrameBeacon, mParserIdentifier, mRssi, mServiceUuid, mTxPower, sDistanceCalculator, sHardwareEqualityEnforced

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AltBeacon()
protected	AltBeacon(Beacon beacon) Copy constructor from base class
protected	AltBeacon(Parcel in) Required for making object Parcelable

Method Summary

Modifier and Type	Method and Description
int	describeContents() Required for making object Parcelable
int	getMfgReserved() Returns a field with a value from 0-255 that can be used for the purposes specified by the manufacturer.
void	writeToParcel(Parcel out, int flags) Required for making object Parcelable

Methods inherited from class org.altbeacon.beacon.Beacon

calculateDistance, equals, getBeaconTypeCode, getBluetoothAddress, getBluetoothName, getDataFields, getDistance, getDistanceCalculator, getExtraDataFields, getFirstCycleDetectionTimestamp, getHardwareEqualityEnforced, getId1, getId2, getId3, getIdentifier, getIdentifiers, getLastCycleDetectionTimestamp, getManufacturer, getMeasurementCount, getPacketCount, getParserIdentifier, getRssi, getRunningAverageRssi, getRunningAverageRssi, getServiceUuid, getTxPower, hashCode, isExtraBeaconData, isMultiFrameBeacon, requestData, setDistanceCalculator, setExtraDataFields, setFirstCycleDetectionTimestamp, setHardwareEqualityEnforced, setLastCycleDetectionTimestamp, setPacketCount, setRssi, setRssiMeasurementCount, setRunningAverageRssi, toString

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<AltBeacon> CREATOR

Required for making object Parcelable. If you override this class, you must provide an equivalent version of this method.

Constructor Detail

AltBeacon

protected AltBeacon(Beacon beacon)

Copy constructor from base class

Parameters:

beacon -

AltBeacon

protected AltBeacon()

See Also:

to make AltBeacon instances

AltBeacon

protected AltBeacon(Parcel in)

Required for making object Parcelable

Method Detail

getMfgReserved

public int getMfgReserved()

Returns a field with a value from 0-255 that can be used for the purposes specified by the manufacturer. The manufacturer specifications for the beacon should be checked before using this field, and the manufacturer should be checked against the Beacon#mManufacturer field

Returns:

mfgReserved

describeContents

public int describeContents()

Required for making object Parcelable

Specified by:

describeContents in interface Parcelable

Overrides:

describeContents in class Beacon

Returns:

writeToParcel

public void writeToParcel(Parcel out,
                          int flags)

Required for making object Parcelable

Specified by:

writeToParcel in interface Parcelable

Overrides:

writeToParcel in class Beacon