com.mobstac.beaconstac.models.MSBeacon Class Reference

Inheritance diagram for com.mobstac.beaconstac.models.MSBeacon:

Public Member Functions
String	getBeaconKey ()
UUID	getBeaconUUID ()
int	getMajor ()
int	getMinor ()
String	getName ()
void	setName (String name)
int	getId ()
void	setId (int identifier)
boolean	getIsCampedOn ()
void	setIsCampedOn (boolean mIsCampedOn)
int	getBias ()
void	setBias (int mBias)
int	getLatestRSSI ()
void	addBeaconState (int state)
boolean	isFar ()
int	getMeanRSSI ()
void	reset ()
	MSBeacon (UUID uuid, int major, int minor)
	MSBeacon (Parcel p)
Public Member Functions inherited from com.mobstac.beaconstac.models.ModelBase
	ModelBase (Object...objects)

Additional Inherited Members
Static Protected Attributes inherited from com.mobstac.beaconstac.models.ModelBase
static final String	idString = "_id"
static final String[]	base_columns = { idString }

Detailed Description

Represents a single beacon in the system.

Constructor & Destructor Documentation

com.mobstac.beaconstac.models.MSBeacon.MSBeacon	(	UUID	uuid,
		int	major,
		int	minor
	)

Constructor for MSBeacon

Parameters

uuid	beacon uuid
major	beacon major
minor	beacon minor

com.mobstac.beaconstac.models.MSBeacon.MSBeacon

(

Parcel

p

)

Parcelable constructor

Member Function Documentation

void com.mobstac.beaconstac.models.MSBeacon.addBeaconState

(

int

state

)

This is used to set the current RSSI value internally.

Parameters

state

Current RSSI value associated to the beacon object

String com.mobstac.beaconstac.models.MSBeacon.getBeaconKey

(

)

Returns the key associated with the beacon

Returns

beacon key of type String

UUID com.mobstac.beaconstac.models.MSBeacon.getBeaconUUID

(

)

Returns the UUID of the beacon

Returns

beacon UUID of type UUID

int com.mobstac.beaconstac.models.MSBeacon.getBias

(

)

getter function for mBias

Returns

bias of type int

int com.mobstac.beaconstac.models.MSBeacon.getId

(

)

Return beacon id as stored in our backend

Returns

id of type int

boolean com.mobstac.beaconstac.models.MSBeacon.getIsCampedOn

(

)

Returns true if the beacon is camped on

Returns

isCampedOn of type boolean

int com.mobstac.beaconstac.models.MSBeacon.getLatestRSSI

(

)

This returns the latest RSSI, Reverse strength Index as registered by the receiver from the beacon

Returns

latest RSSI of type int

int com.mobstac.beaconstac.models.MSBeacon.getMajor

(

)

Returns the major value of the beacon

Returns

major of the beacon of type int

int com.mobstac.beaconstac.models.MSBeacon.getMeanRSSI

(

)

Returns the mean of previous three RSSI values associated with the beacon.

Returns

mean RSSI of type int

int com.mobstac.beaconstac.models.MSBeacon.getMinor

(

)

Returns the minor value of the beacon

Returns

minor of the beacon of type int

String com.mobstac.beaconstac.models.MSBeacon.getName

(

)

Returns the beacon name

Returns

name of type String

boolean com.mobstac.beaconstac.models.MSBeacon.isFar

(

)

States if the proximity of the beacon is far

Returns

Boolean value to state if beacon is far

void com.mobstac.beaconstac.models.MSBeacon.reset

(

)

reset the values intended to be called on exit

void com.mobstac.beaconstac.models.MSBeacon.setBias

(

int

mBias

)

setter function for mBias

Parameters

mBias

of type int

void com.mobstac.beaconstac.models.MSBeacon.setId

(

int

identifier

)

Set beacon id Caution: Using this method improperly can cause problems.

Parameters

identifier

of type int

void com.mobstac.beaconstac.models.MSBeacon.setIsCampedOn

(

boolean

mIsCampedOn

)

setter function for mIsCampedOn

Parameters

mIsCampedOn

of type boolean

void com.mobstac.beaconstac.models.MSBeacon.setName

(

String

name

)

Sets the beacon name

Parameters

name	of type string

---

The documentation for this class was generated from the following file:

• MSBeacon.java