com.dsi.ant.message.fromhost

Class ProximitySearchMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.ProximitySearchMessage

public final class ProximitySearchMessage
extends AntMessageFromHost

Configures the proximity search value that the channel will use. The channel will only discover devices in bins less than or equal to the bin number specified.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SEARCH_THRESHOLD The maximum bin number accepted by ANT
static int	MIN_SEARCH_THRESHOLD The minimum bin number accepted by ANT
static int	OFFSET_SEARCH_THRESHOLD The message content offset to the search threshold value
static int	PROXIMITY_SEARCH_DISABLED The value that will disable proximity search for the channel
static int	SIZE_SEARCH_THRESHOLD The number of bytes to be used for the search threshold value

Fields inherited from class com.dsi.ant.message.AntMessage

BITMASK_CHANNEL_NUMBER, FILLER_BYTE, OFFSET_CHANNEL_NUMBER, RAW_OFFSET_MESSAGE_CONTENT_START, RAW_OFFSET_MESSAGE_ID, RAW_OFFSET_MESSAGE_SIZE, SIZE_CHANNEL_NUMBER, SIZE_FILLER_BYTE

Constructor Summary

Constructors

Constructor and Description
ProximitySearchMessage(int searchThreshold) Constructs the message from the given search threshold.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getMessageContent(int channelNumber, int networkNumbe) The content of the message with specified channel number and network number set if required.
MessageFromHostType	getMessageType() The unique type of this message based on its message id, contents, and intended channel type.
int	getSearchThreshold() Gets the search threshold for the message.
java.lang.String	toString()

Methods inherited from class com.dsi.ant.message.fromhost.AntMessageFromHost

createAntMessage, getMessageContent, getMessageContent, getMessageId, getRawMessage

Methods inherited from class com.dsi.ant.message.AntMessage

equals, getMessageContentString, getMessageIdString, hashCode, maskChannelNumber

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SIZE_SEARCH_THRESHOLD

public static final int SIZE_SEARCH_THRESHOLD

The number of bytes to be used for the search threshold value

Since:

4.0

See Also:

Constant Field Values

OFFSET_SEARCH_THRESHOLD

public static final int OFFSET_SEARCH_THRESHOLD

The message content offset to the search threshold value

Since:

4.0

See Also:

Constant Field Values

PROXIMITY_SEARCH_DISABLED

public static final int PROXIMITY_SEARCH_DISABLED

The value that will disable proximity search for the channel

Since:

4.0

See Also:

Constant Field Values

MIN_SEARCH_THRESHOLD

public static final int MIN_SEARCH_THRESHOLD

The minimum bin number accepted by ANT

Since:

4.0

See Also:

Constant Field Values

MAX_SEARCH_THRESHOLD

public static final int MAX_SEARCH_THRESHOLD

The maximum bin number accepted by ANT

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

ProximitySearchMessage

public ProximitySearchMessage(int searchThreshold)

Constructs the message from the given search threshold.

Parameters:

searchThreshold - The bin number. ANT will discover devices in bins less than or equal to the bin number.

Since:

4.0

Method Detail

getSearchThreshold

public int getSearchThreshold()

Gets the search threshold for the message.

Returns:

The bin number. ANT will discover devices in bins less than or equal to the bin number.

Since:

4.0

getMessageContent

public byte[] getMessageContent(int channelNumber,
                       int networkNumbe)

Description copied from class: AntMessageFromHost

The content of the message with specified channel number and network number set if required.

Specified by:

getMessageContent in class AntMessageFromHost

Parameters:

channelNumber - Written to the channel number byte if required

networkNumbe - Written to the network number byte if required

Returns:

Message content raw byte array.

Since:

4.0

getMessageType

public MessageFromHostType getMessageType()

Description copied from class: AntMessageFromHost

The unique type of this message based on its message id, contents, and intended channel type.

It is recommended to use this rather than the raw message ID.

Specified by:

getMessageType in class AntMessageFromHost

Returns:

The type of message returned by the host.

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class AntMessageFromHost