com.dsi.ant.message.fromhost

Class ChannelRfFrequencyMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.ChannelRfFrequencyMessage

public final class ChannelRfFrequencyMessage
extends AntMessageFromHost

Configures the frequency this channel will operate on.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RF_FREQUENCY The maximum frequency value ANT will accept
static int	MIN_RF_FREQUENCY The minimum frequency value ANT will accept
static int	OFFSET_RF_FREQUENCY The message content offset to the frequency value
static int	RF_FREQUENCY_BASE_VALUE The real world channel frequency (MHz) is calculated by taking the set value and adding it to this starting value.
static int	SIZE_RF_FREQUENCY The number of bytes used for the 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
ChannelRfFrequencyMessage(int rfFrequency) Constructs the message from the given frequency value.

Method Summary

Methods

Modifier and Type	Method and Description
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.
int	getRealRfFrequency()
static int	getRealRfFrequency(int rfFrequencyOffset) Converts an ANT Channel RF Frequency value to the real world frequency.
int	getRfFrequency() Gets the frequency (offset) value contained in the message.
static int	getRfFrequencyOffset(int realRfFrequency)
static boolean	inRange(int frequency) Determines if the frequency is within the acceptable range for ANT chips.
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_RF_FREQUENCY

public static final int OFFSET_RF_FREQUENCY

The message content offset to the frequency value

Since:

4.0

See Also:

Constant Field Values

SIZE_RF_FREQUENCY

public static final int SIZE_RF_FREQUENCY

The number of bytes used for the frequency value

Since:

4.0

See Also:

Constant Field Values

MIN_RF_FREQUENCY

public static final int MIN_RF_FREQUENCY

The minimum frequency value ANT will accept

Since:

4.0

See Also:

Constant Field Values

MAX_RF_FREQUENCY

public static final int MAX_RF_FREQUENCY

The maximum frequency value ANT will accept

Since:

4.0

See Also:

Constant Field Values

RF_FREQUENCY_BASE_VALUE

public static final int RF_FREQUENCY_BASE_VALUE

The real world channel frequency (MHz) is calculated by taking the set value and adding it to this starting value.

Real Channel Frequency = 2400 MHz + Channel RF Frequency Number

Since:

4.5

See Also:

Constant Field Values

Constructor Detail

ChannelRfFrequencyMessage

public ChannelRfFrequencyMessage(int rfFrequency)

Constructs the message from the given frequency value.

Parameters:

rfFrequency - The frequency offset of 2400 MHz (e.g. 50 MHz for 2450 MHz).

Since:

4.0

Method Detail

inRange

public static final boolean inRange(int frequency)

Determines if the frequency is within the acceptable range for ANT chips.

Parameters:

frequency - The frequency offset of 2400 MHz (e.g. 50 MHz for 2450 MHz) to be checked.

Returns:

True, if in range. False, otherwise.

Since:

4.0

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

getRealRfFrequency

public int getRealRfFrequency()

getRfFrequencyOffset

public static int getRfFrequencyOffset(int realRfFrequency)

getRfFrequency

public int getRfFrequency()

Gets the frequency (offset) value contained in the message.

Returns:

The frequency offset of 2400 MHz (e.g. 50 MHz for 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