com.dsi.ant.message.fromhost

Class SetChannelTransmitPowerMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.SetChannelTransmitPowerMessage

public final class SetChannelTransmitPowerMessage
extends AntMessageFromHost

Sets the power that the channel will transmit.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_TRANSMIT_POWER_LEVEL The minimum transmit power value accepted by ANT
static int	OFFSET_TX_POWER The message content offset to the transmit power value
static int	SIZE_TX_POWER The number of bytes used for the transmit power 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
SetChannelTransmitPowerMessage(int outputPowerLevelSetting, Capabilities capabilities)

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.
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_TX_POWER

public static final int OFFSET_TX_POWER

The message content offset to the transmit power value

Since:

4.0

See Also:

Constant Field Values

SIZE_TX_POWER

public static final int SIZE_TX_POWER

The number of bytes used for the transmit power value

Since:

4.0.

See Also:

Constant Field Values

MIN_TRANSMIT_POWER_LEVEL

public static final int MIN_TRANSMIT_POWER_LEVEL

The minimum transmit power value accepted by ANT

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

SetChannelTransmitPowerMessage

public SetChannelTransmitPowerMessage(int outputPowerLevelSetting,
                              Capabilities capabilities)

Parameters:

outputPowerLevelSetting - Which settings index to use to get actual power level

capabilities - Used to check the valid range of Transmit Power Level Settings

Since:

4.0

Method Detail

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