com.dsi.ant.message.fromhost

Class FrequencyAgilityMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.FrequencyAgilityMessage

public final class FrequencyAgilityMessage
extends AntMessageFromHost

Configures the frequency agility feature which changes frequency if significant degradation is experienced.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFSET_FREQUENCY_ONE The message content offset the first frequency value
static int	OFFSET_FREQUENCY_THREE The message content offset the third frequency value
static int	OFFSET_FREQUENCY_TWO The message content offset the second frequency 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
FrequencyAgilityMessage(int frequencyOne, int frequencyTwo, int frequencyThree) Constructs the message with the give values for the frequencies to be used.

Method Summary

Methods

Modifier and Type	Method and Description
int	getFrequencyOne() Gets the first frequency value.
int	getFrequencyThree() Gets the third frequency value.
int	getFrequencyTwo() Gets the second frequency value.
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.
static int	getRealRfFrequency(int rfFrequencyOffset) Converts an ANT Channel RF Frequency value to the real world frequency.
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

OFFSET_FREQUENCY_ONE

public static final int OFFSET_FREQUENCY_ONE

The message content offset the first frequency value

Since:

4.0

See Also:

Constant Field Values

OFFSET_FREQUENCY_TWO

public static final int OFFSET_FREQUENCY_TWO

The message content offset the second frequency value

Since:

4.0

See Also:

Constant Field Values

OFFSET_FREQUENCY_THREE

public static final int OFFSET_FREQUENCY_THREE

The message content offset the third frequency value

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

FrequencyAgilityMessage

public FrequencyAgilityMessage(int frequencyOne,
                       int frequencyTwo,
                       int frequencyThree)

Constructs the message with the give values for the frequencies to be used.

Parameters:

frequencyOne - The first frequency value as an offset of 2400 MHz

frequencyTwo - The first frequency value as an offset of 2400 MHz

frequencyThree - The first frequency value as an offset of 2400 MHz

Since:

4.0

Method Detail

getRealRfFrequency

public static int getRealRfFrequency(int rfFrequencyOffset)

Converts an ANT Channel RF Frequency value to the real world frequency.

Parameters:

rfFrequencyOffset - The set ANT Channel RF Frequency as an offset.

Returns:

The channel period in 1/32768ths of a second units.

Since:

4.5

getFrequencyOne

public int getFrequencyOne()

Gets the first frequency value.

Returns:

The frequency as an offset of 2400 MHz (e.g. 50MHz is 2450 MHz).

Since:

4.0

getFrequencyTwo

public int getFrequencyTwo()

Gets the second frequency value.

Returns:

The frequency as an offset of 2400 MHz (e.g. 50MHz is 2450 MHz).

Since:

4.0

getFrequencyThree

public int getFrequencyThree()

Gets the third frequency value.

Returns:

The frequency as an offset of 2400 MHz (e.g. 50MHz is 2450 MHz).

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