com.dsi.ant.message.fromhost

Class SerialNumberSetChannelIdMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.SerialNumberSetChannelIdMessage

public final class SerialNumberSetChannelIdMessage
extends AntMessageFromHost

Sets the channel ID for the channel, using the two least significant bytes for the device's serial number.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	BITMASK_DEVICE_TYPE The mask used to retrieve the device type
static int	BITMASK_PAIR The mask used to retrieve the pairing bit
static int	OFFSET_DEVICE_TYPE The message content offset to the device type
static int	OFFSET_PAIRING_BIT The message content offset to the byte containing the pairing bit
static int	OFFSET_TRANSMISSION_TYPE The message content offset to the transmission type
static int	SIZE_DEVICE_TYPE The number of bytes used for the device type
static int	SIZE_TRANSMISSION_TYPE The number of bytes used for the transmission type

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
SerialNumberSetChannelIdMessage(boolean pair, int deviceType, int transmissionType) Constructs the message from the given channel ID parameters.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDeviceType() The value of the device type.
byte[]	getMessageContent(int channelNumber, int networkNumber) 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.
boolean	getPair() Returns the value of the pairing bit.
int	getTransmissionType() The value of the transmission type.
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_DEVICE_TYPE

public static final int SIZE_DEVICE_TYPE

The number of bytes used for the device type

Since:

4.0

See Also:

Constant Field Values

SIZE_TRANSMISSION_TYPE

public static final int SIZE_TRANSMISSION_TYPE

The number of bytes used for the transmission type

Since:

4.0

See Also:

Constant Field Values

OFFSET_PAIRING_BIT

public static final int OFFSET_PAIRING_BIT

The message content offset to the byte containing the pairing bit

Since:

4.0

See Also:

Constant Field Values

OFFSET_DEVICE_TYPE

public static final int OFFSET_DEVICE_TYPE

The message content offset to the device type

Since:

4.0

See Also:

Constant Field Values

OFFSET_TRANSMISSION_TYPE

public static final int OFFSET_TRANSMISSION_TYPE

The message content offset to the transmission type

Since:

4.0

See Also:

Constant Field Values

BITMASK_DEVICE_TYPE

public static final int BITMASK_DEVICE_TYPE

The mask used to retrieve the device type

Since:

4.0

See Also:

Constant Field Values

BITMASK_PAIR

public static final int BITMASK_PAIR

The mask used to retrieve the pairing bit

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

SerialNumberSetChannelIdMessage

public SerialNumberSetChannelIdMessage(boolean pair,
                               int deviceType,
                               int transmissionType)

Constructs the message from the given channel ID parameters.

Parameters:

pair - The pairing bit.

deviceType - The class or type of the ANT device

transmissionType - Denotes certain transmission characteristics of a device

Since:

4.0

Method Detail

getPair

public boolean getPair()

Returns the value of the pairing bit. For devices to connect during a wildcard search, devices must have matching pairing bits.

Returns:

True if the pairing bit is set.

Since:

4.0

getDeviceType

public int getDeviceType()

The value of the device type.

Returns:

The device type.

Since:

4.0

getTransmissionType

public int getTransmissionType()

The value of the transmission type.

Returns:

The transmission type.

Since:

4.0

getMessageContent

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

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

networkNumber - 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