Package com.dsi.ant.message.fromhost
Class ChannelSearchPriorityMessage
java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.ChannelSearchPriorityMessage
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
default search priority of a channelstatic final int
Min and max of allowable channel search priority when set with API.static final int
static final int
The message content offset to the channel periodstatic final int
The number of bytes used for the channel periodFields 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
ConstructorsModifierConstructorDescriptionprotected
ChannelSearchPriorityMessage
(byte[] messageContent) ChannelSearchPriorityMessage
(int searchPriority) Constructs the message from the given channel search priority [4 - 11]. -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the channel search priority this message configures.byte[]
getMessageContent
(int channelNumber, int networkNumber) The content of the message with specified channel number and network number set if required.The unique type of this message based on its message id, contents, and intended channel type.toString()
Methods inherited from class com.dsi.ant.message.fromhost.AntMessageFromHost
createAntMessage, createAntMessage, getMessageContent, getMessageContent, getMessageId, getRawMessage, toStringHeader
Methods inherited from class com.dsi.ant.message.AntMessage
equals, getMessageContentString, getMessageIdString, hashCode, maskChannelNumber
-
Field Details
-
OFFSET_SEARCH_PRIORITY
public static final int OFFSET_SEARCH_PRIORITYThe message content offset to the channel period- Since:
- 4.7.3
- See Also:
-
SIZE_SEARCH_PRIORITY
public static final int SIZE_SEARCH_PRIORITYThe number of bytes used for the channel period- Since:
- 4.7.3
- See Also:
-
LIB_MAX_SEARCH_PRIORITY
public static final int LIB_MAX_SEARCH_PRIORITYMin and max of allowable channel search priority when set with API. The ranges [0 - 3] and [12 - 15] are system reserved.- See Also:
-
LIB_MIN_SEARCH_PRIORITY
public static final int LIB_MIN_SEARCH_PRIORITY- See Also:
-
LIB_DEFAULT_SEARCH_PRIORITY
public static final int LIB_DEFAULT_SEARCH_PRIORITYdefault search priority of a channel- See Also:
-
-
Constructor Details
-
ChannelSearchPriorityMessage
public ChannelSearchPriorityMessage(int searchPriority) Constructs the message from the given channel search priority [4 - 11]. Higher numbers are given higher priority.- Parameters:
searchPriority
- priority to be used for this channel.- Since:
- 4.7.3
-
ChannelSearchPriorityMessage
protected ChannelSearchPriorityMessage(byte[] messageContent)
-
-
Method Details
-
getChannelSearchPriority
public int getChannelSearchPriority()Gets the channel search priority this message configures.- Returns:
- The channel search priority.
- Since:
- 4.7.3
-
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 classAntMessageFromHost
- Parameters:
channelNumber
- Written to the channel number byte if requirednetworkNumber
- Written to the network number byte if required- Returns:
- Message content raw byte array.
- Since:
- 4.7.3
-
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 classAntMessageFromHost
- Returns:
- The type of message returned by the host.
- Since:
- 4.7.3
-
toString
- Overrides:
toString
in classAntMessageFromHost
-