com.dsi.ant.message

Class LibConfig

java.lang.Object

com.dsi.ant.message.LibConfig

public final class LibConfig
extends java.lang.Object

Specifies which ExtendedData to be included in received messages.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LibConfig.Flag The flags which indicate which features to enable in a raw Lib Config byte.

Field Summary

Fields

Modifier and Type	Field and Description
static	CREATOR For Parcelable

Constructor Summary

Constructors

Constructor and Description
LibConfig() Constructs the LibConfig with all flags set to false by default.
LibConfig(boolean enableChannelIdOutput, boolean enableRssiOutput, boolean enableRxTimestampOutput) Constructs the LibConfig with the given values for the flags

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object obj)
boolean	getEnableChannelIdOutput() Gets the flag for enabling channel ID in ExtendedData.
boolean	getEnableRssiOutput() Gets the flag for enabling RSSI data in ExtendedData.
boolean	getEnableRxTimestampOutput() Gets the flag for enabling timestamp in ExtendedData.
byte	getFlagsByte() Gets the byte representing the LibConfig settings.
int	hashCode()
void	setEnableChannelIdOutput(boolean on) Enable or disable channel ID in ExtendedData.
void	setEnableRssiOutput(boolean on) Enable or disable RSSI data in ExtendedData.
void	setEnableRxTimestampOutput(boolean on) Enable or disable timestamp in ExtendedData.
java.lang.String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final  CREATOR

For Parcelable

Since:

4.0

Constructor Detail

LibConfig

public LibConfig()

Constructs the LibConfig with all flags set to false by default.

Since:

4.0

LibConfig

public LibConfig(boolean enableChannelIdOutput,
         boolean enableRssiOutput,
         boolean enableRxTimestampOutput)

Constructs the LibConfig with the given values for the flags

Parameters:

enableChannelIdOutput - Indicates if channel ID is to be included in ExtendedData

enableRssiOutput - Indicates if RSSI data is to be included in ExtendedData

enableRxTimestampOutput - Indicates if timestamp is to be included in ExtendedData

Since:

4.0

Method Detail

getEnableChannelIdOutput

public boolean getEnableChannelIdOutput()

Gets the flag for enabling channel ID in ExtendedData.

Returns:

True, if channel ID is enabled. False, otherwise.

Since:

4.0

getEnableRssiOutput

public boolean getEnableRssiOutput()

Gets the flag for enabling RSSI data in ExtendedData.

Returns:

True, if RSSI data is enabled. False, otherwise.

Since:

4.0

getEnableRxTimestampOutput

public boolean getEnableRxTimestampOutput()

Gets the flag for enabling timestamp in ExtendedData.

Returns:

True, if timestamp is enabled. False, otherwise.

Since:

4.0

setEnableChannelIdOutput

public void setEnableChannelIdOutput(boolean on)

Enable or disable channel ID in ExtendedData.

Parameters:

on - True to include channel ID. False, otherwise.

Since:

4.0

setEnableRssiOutput

public void setEnableRssiOutput(boolean on)

Enable or disable RSSI data in ExtendedData.

Parameters:

on - True to include RSSI data. False, otherwise.

Since:

4.0

setEnableRxTimestampOutput

public void setEnableRxTimestampOutput(boolean on)

Enable or disable timestamp in ExtendedData.

Parameters:

on - True to include timestamp. False, otherwise.

Since:

4.0

getFlagsByte

public byte getFlagsByte()

Gets the byte representing the LibConfig settings. Applications should use the methods provided in LibConfig to set/get extended data flags contained in LibConfig.

Returns:

The flags byte.

Since:

4.0

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Since:

4.0

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

4.0

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)