com.mbientlab.metawear.api.controller

Enum IBeacon.Register

java.lang.Object

java.lang.Enum<IBeacon.Register>

com.mbientlab.metawear.api.controller.IBeacon.Register

All Implemented Interfaces:

Register, java.io.Serializable, java.lang.Comparable<IBeacon.Register>

Enclosing interface:

IBeacon

public static enum IBeacon.Register
extends java.lang.Enum<IBeacon.Register>
implements Register

Enumeration of registers under the IBeacon module. The registers also function as keys for the IBeacon settings.

Author:

Eric Tsai

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADVERTISEMENT_PERIOD Contains the advertisement period.
ADVERTISEMENT_UUID Contains IBeacon advertisement UUID.
ENABLE Checks the enable status and enables/disables IBeacon mode
MAJOR Contains advertisement major number.
MINOR Contains advertisement minor number.
RX_POWER Contains the receiving power.
TX_POWER Contains the transmitting power.

Method Summary

Methods

Modifier and Type	Method and Description
Module	module() Get the module the register belongs to
static IBeacon.Register	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IBeacon.Register[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.mbientlab.metawear.api.Register

notifyCallbacks, opcode

Enum Constant Detail

ENABLE

public static final IBeacon.Register ENABLE

Checks the enable status and enables/disables IBeacon mode

ADVERTISEMENT_UUID

public static final IBeacon.Register ADVERTISEMENT_UUID

Contains IBeacon advertisement UUID. Reading from the register will trigger a call to receivedUUID with the advertisement uuid

See Also:

IBeacon.Callbacks.receivedUUID(UUID)

MAJOR

public static final IBeacon.Register MAJOR

Contains advertisement major number. Reading from the register will trigger a call to receivedMajor with the major number

See Also:

IBeacon.Callbacks.receivedMajor(short)

MINOR

public static final IBeacon.Register MINOR

Contains advertisement minor number. Reading from the register will trigger a call to receivedMinor with the minor number

See Also:

IBeacon.Callbacks.receivedMinor(short)

RX_POWER

public static final IBeacon.Register RX_POWER

Contains the receiving power. Reading from the register will trigger a call to receivedRXPower with the receiving power

See Also:

IBeacon.Callbacks.receivedRXPower(byte)

TX_POWER

public static final IBeacon.Register TX_POWER

Contains the transmitting power. Reading from the register will trigger a call to receivedTXPower with the transmitting power

See Also:

IBeacon.Callbacks.receivedTXPower(byte)

ADVERTISEMENT_PERIOD

public static final IBeacon.Register ADVERTISEMENT_PERIOD

Contains the advertisement period. Reading from the register will trigger a call to receivedPeriod with the advertisement period

See Also:

IBeacon.Callbacks.receivedPeriod(short)

Method Detail

values

public static IBeacon.Register[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IBeacon.Register c : IBeacon.Register.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IBeacon.Register valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

module

public Module module()

Description copied from interface: Register

Get the module the register belongs to

Specified by:

module in interface Register

Returns:

Parent module