com.dsi.ant.message.fromant

Class CapabilitiesMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromant.AntMessageFromAnt

com.dsi.ant.message.fromant.CapabilitiesMessage

public final class CapabilitiesMessage
extends AntMessageFromAnt

Provides possible ANT capabilities, and whether they are supported or not. Constants defined in Options are used to access the capability option information.

See the ANT Message Protocol and Usage document for more details.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CapabilitiesMessage.AdvancedOptions Capabilities under advanced options
class	CapabilitiesMessage.AdvancedOptions2 Capabilities under advanced options 2
class	CapabilitiesMessage.AdvancedOptions3 Capabilities under advanced options 3
class	CapabilitiesMessage.MessageOffsets Offsets used to parse the capabilities message message content
static class	CapabilitiesMessage.Option Summary of the ANT device's capability options.
class	CapabilitiesMessage.StandardOptions Capabilities under standard options

Field Summary

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
CapabilitiesMessage(AntMessageParcel messageParcel) Parse message specific information from the given ANT message parcel.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	getCapability(CapabilitiesMessage.Option option) Accessor method for the various capabilities settings.
MessageFromAntType	getMessageType() The type of this message based on its message id and contents.
int	getNumberOfChannels() Returns the number of channels supported by the ANT hardware.
int	getNumberOfNetworks() Returns how many networks are supported by this channel.
int	hashCode()
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

getMessageContentString, getMessageIdString, maskChannelNumber

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CapabilitiesMessage

public CapabilitiesMessage(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

getCapability

public boolean getCapability(CapabilitiesMessage.Option option)

Accessor method for the various capabilities settings.

Parameters:

option - An enum of the Capability type

Returns:

true if capability is available, false otherwise.

Since:

4.0

hashCode

public int hashCode()

Overrides:

hashCode in class AntMessage

Since:

4.0

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AntMessage

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class AntMessageFromAnt

Since:

4.0

getNumberOfChannels

public int getNumberOfChannels()

Returns the number of channels supported by the ANT hardware.

Returns:

The number of channels supported.

Since:

4.0

getNumberOfNetworks

public int getNumberOfNetworks()

Returns how many networks are supported by this channel.

Returns:

The number of networks supported.

Since:

4.0

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