com.dsi.ant.message.fromhost

Class AntMessageFromHost

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

Direct Known Subclasses:

AddChannelIdToListMessage, AssignChannelMessage, ChannelIdMessageFromHost, ChannelPeriodMessage, ChannelRfFrequencyMessage, ChannelSearchPriorityMessage, CloseChannelMessage, ConfigIdListMessage, ConfigureEventBufferMessage, CrystalEnableMessage, CwInitMessage, DataMessageFromHost, FrequencyAgilityMessage, LibConfigMessage, LoadOrStoreEncryptionKeyMessage, LowPrioritySearchTimeoutMessage, OpenChannelMessage, OpenRxScanModeMessage, ProximitySearchMessage, RequestMessage, ResetSystemMessage, SearchTimeoutMessage, SerialNumberSetChannelIdMessage, SetChannelTransmitPowerMessage, SetNetworkKeyMessage, SleepMessage, TransmitPowerMessage, UnassignChannelMessage

public abstract class AntMessageFromHost
extends AntMessage

A message sent Host -> ANT. Takes individual pieces of information from an application, and the message type and sends this to the ANT Radio Service, which is pieced together to a single ANT message byte array.

Since:

4.0

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
AntMessageFromHost()

Method Summary

Methods

Modifier and Type	Method and Description
static AntMessageFromHost	createAntMessage(AntMessageParcel antParcel, ChannelType channelType) Takes a message received over IPC and converts it to an AntMessageFromHost object
byte[]	getMessageContent() The content of the message with no channel number or network number set.
byte[]	getMessageContent(int channelNumber) The content of the message with specified channel number set if required.
abstract byte[]	getMessageContent(int channelNumber, int networkNumber) The content of the message with specified channel number and network number set if required.
int	getMessageId() Get the ANT message ID.
abstract MessageFromHostType	getMessageType() The unique type of this message based on its message id, contents, and intended channel type.
byte[]	getRawMessage(int channelNumber, int networkNumber) Creates a message which can be written to the chip.
java.lang.String	toString()

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

Constructor Detail

AntMessageFromHost

public AntMessageFromHost()

Method Detail

getMessageId

public int getMessageId()

Description copied from class: AntMessage

Get the ANT message ID.

Specified by:

getMessageId in class AntMessage

Returns:

Raw value of this messages Message ID byte.

Since:

4.0

getMessageType

public abstract MessageFromHostType getMessageType()

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.

Returns:

The type of message returned by the host.

Since:

4.0

getMessageContent

public byte[] getMessageContent()

The content of the message with no channel number or network number set.

Specified by:

getMessageContent in class AntMessage

Returns:

Message content raw byte array.

Since:

4.0

getMessageContent

public byte[] getMessageContent(int channelNumber)

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

Parameters:

channelNumber - Written to the channel number byte if required

Returns:

Raw byte array with network number not set.

Since:

4.0

getMessageContent

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

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

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

getRawMessage

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

Creates a message which can be written to the chip.

Parameters:

channelNumber - Specific channel to write in to this message, if required.

networkNumber - Specific network to write in to this message, if required.

Returns:

An ANT message that can be written to the chip.

Since:

4.0

createAntMessage

public static AntMessageFromHost createAntMessage(AntMessageParcel antParcel,
                                  ChannelType channelType)

Takes a message received over IPC and converts it to an AntMessageFromHost object

Parameters:

antParcel - The basic ANT message data received over IPC.

Returns:

A new specific message type instance, or NULL if not a From Host message or not a known MessageFromHostType.

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class AntMessage

Since:

4.0