com.dsi.ant.message.fromhost

Class LibConfigMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.LibConfigMessage

public final class LibConfigMessage
extends AntMessageFromHost

Configures which extended data information to be included in the received messages from devices.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	BITMASK_CHANNEL_ID_OUTPUT The mask to be used to get the enable channel ID flag
static int	BITMASK_RSSI_OUTPUT The mask to be used to get the enable RSSI data flag
static int	BITMASK_RX_TIMESTAMP The mask to be used to get the enable timestamp flag
static int	OFFSET_LIBCONFIG_FLAGS The message content offset to the byte containing the values for the flags
static int	SIZE_LIBCONFIG_FLAGS The number of bytes used for the flags

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
LibConfigMessage(LibConfig libConfig) Constructs the message from the given LibConfig object

Method Summary

Methods

Modifier and Type	Method and Description
LibConfig	getLibConfig() Gets the LibConfig object that is represented by this message.
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.
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

BITMASK_RX_TIMESTAMP

public static final int BITMASK_RX_TIMESTAMP

The mask to be used to get the enable timestamp flag

Since:

4.0

See Also:

Constant Field Values

BITMASK_RSSI_OUTPUT

public static final int BITMASK_RSSI_OUTPUT

The mask to be used to get the enable RSSI data flag

Since:

4.0

See Also:

Constant Field Values

BITMASK_CHANNEL_ID_OUTPUT

public static final int BITMASK_CHANNEL_ID_OUTPUT

The mask to be used to get the enable channel ID flag

Since:

4.0

See Also:

Constant Field Values

OFFSET_LIBCONFIG_FLAGS

public static final int OFFSET_LIBCONFIG_FLAGS

The message content offset to the byte containing the values for the flags

Since:

4.0

See Also:

Constant Field Values

SIZE_LIBCONFIG_FLAGS

public static final int SIZE_LIBCONFIG_FLAGS

The number of bytes used for the flags

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

LibConfigMessage

public LibConfigMessage(LibConfig libConfig)

Constructs the message from the given LibConfig object

Parameters:

libConfig - The desired LibConfig.

Since:

4.0

Method Detail

getLibConfig

public LibConfig getLibConfig()

Gets the LibConfig object that is represented by this message.

Returns:

The desired LibConfig.

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