com.dsi.ant.message.fromant

Class ChannelStatusMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromant.AntMessageFromAnt

com.dsi.ant.message.fromant.ChannelStatusMessage

public class ChannelStatusMessage
extends AntMessageFromAnt

Message that returns the status of the channel.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static byte	BITMASK_STATUS_CHANNEL_STATE The mask used to retrieve the channel state
static byte	BITMASK_STATUS_CHANNEL_TYPE The mask used to retrieve the channel type
static int	BITSHIFT_STATUS_CHANNEL_STATE The shift applied to the retrieved channel state value
static int	BITSHIFT_STATUS_CHANNEL_TYPE The shift applied to the retrieved channel type value
static int	OFFSET_CHANNEL_STATUS The message content offset to the channel status 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
ChannelStatusMessage(AntMessageParcel messageParcel) Parse message specific information from the given ANT message parcel.

Method Summary

Methods

Modifier and Type	Method and Description
ChannelState	getChannelState() Gets the channel state of the channel
ChannelType	getChannelType() Gets the channel type of the channel.
MessageFromAntType	getMessageType() The type of this message based on its message id and contents.
java.lang.String	toString()

Methods inherited from class com.dsi.ant.message.fromant.AntMessageFromAnt

createAntMessage, createAntMessage, getMessageContent, getMessageId

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

OFFSET_CHANNEL_STATUS

public static final int OFFSET_CHANNEL_STATUS

The message content offset to the channel status value

Since:

4.0

See Also:

Constant Field Values

BITMASK_STATUS_CHANNEL_TYPE

public static final byte BITMASK_STATUS_CHANNEL_TYPE

The mask used to retrieve the channel type

Since:

4.0

See Also:

Constant Field Values

BITMASK_STATUS_CHANNEL_STATE

public static final byte BITMASK_STATUS_CHANNEL_STATE

The mask used to retrieve the channel state

Since:

4.0

See Also:

Constant Field Values

BITSHIFT_STATUS_CHANNEL_TYPE

public static final int BITSHIFT_STATUS_CHANNEL_TYPE

The shift applied to the retrieved channel type value

Since:

4.0

See Also:

Constant Field Values

BITSHIFT_STATUS_CHANNEL_STATE

public static final int BITSHIFT_STATUS_CHANNEL_STATE

The shift applied to the retrieved channel state value

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

ChannelStatusMessage

public ChannelStatusMessage(AntMessageParcel messageParcel)

Parse message specific information from the given ANT message parcel.

Parameters:

messageParcel - Raw ANT message received form the ANT Radio Service.

Throws:

java.lang.IllegalArgumentException - If the parcel is for the wrong message type.

Since:

4.0

Method Detail

getMessageType

public MessageFromAntType getMessageType()

Description copied from class: AntMessageFromAnt

The type of this message based on its message id and contents.

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

Specified by:

getMessageType in class AntMessageFromAnt

Returns:

A message type corresponding to this message as defined in MessageFromAntType.

Since:

4.0

getChannelType

public ChannelType getChannelType()

Gets the channel type of the channel.

Returns:

The ChannelType.

Since:

4.0

getChannelState

public ChannelState getChannelState()

Gets the channel state of the channel

Returns:

The ChannelState.

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class AntMessageFromAnt

Since:

4.0