com.dsi.ant.message.fromhost

Class ConfigureEventBufferMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.ConfigureEventBufferMessage

public final class ConfigureEventBufferMessage
extends AntMessageFromHost

Configures the event buffer for the ANT chip.

Since:

4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigureEventBufferMessage.BufferEvents The groups of messages to buffer.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigureEventBufferMessage	DISABLE_EVENT_BUFFERING Singleton disable event buffering message.
static int	MAX_BUFFER_SIZE The maximum value allowed for the buffer size
static int	MAX_BUFFER_TIME The maximum value allowed for the buffer time
static int	MIN_BUFFER_SIZE The minimum value allowed for the buffer size
static int	MIN_BUFFER_TIME The minimum value allowed for the buffer time
static int	OFFSET_BUFFER_EVENTS The message content offset to the buffer events value
static int	OFFSET_BUFFER_SIZE The message content offset to the buffer size value
static int	OFFSET_BUFFER_TIME The message content offset to the buffer time value
static int	SIZE_BUFFER_EVENTS The number of bytes used for the buffer events value
static int	SIZE_BUFFER_SIZE The number of bytes used for the buffer size value
static int	SIZE_BUFFER_TIME The number of bytes used for the buffer time value
static int	TIME_INCREMENTS Buffer Time is specified in 10ms units

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
ConfigureEventBufferMessage(ConfigureEventBufferMessage.BufferEvents events, int bufferSize, int bufferTime)

Method Summary

Methods

Modifier and Type	Method and Description
ConfigureEventBufferMessage.BufferEvents	getBufferEvents() Gets the types of events that will be buffered.
int	getMaxBufferSizeBeforeFlush() Gets the number of bytes the buffer will hold until flushing all events buffered.
int	getMaxBufferTimeBeforeFlush() Gets the duration the buffer will buffer events before flushing all the buffered events.
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	getRealMaxBufferTimeBeforeFlush() Gets the duration events will be buffered for before flushing all events.
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

SIZE_BUFFER_EVENTS

public static final int SIZE_BUFFER_EVENTS

The number of bytes used for the buffer events value

Since:

4.1

See Also:

Constant Field Values

SIZE_BUFFER_SIZE

public static final int SIZE_BUFFER_SIZE

The number of bytes used for the buffer size value

Since:

4.1

See Also:

Constant Field Values

SIZE_BUFFER_TIME

public static final int SIZE_BUFFER_TIME

The number of bytes used for the buffer time value

Since:

4.1

See Also:

Constant Field Values

OFFSET_BUFFER_EVENTS

public static final int OFFSET_BUFFER_EVENTS

The message content offset to the buffer events value

Since:

4.1

See Also:

Constant Field Values

OFFSET_BUFFER_SIZE

public static final int OFFSET_BUFFER_SIZE

The message content offset to the buffer size value

Since:

4.1

See Also:

Constant Field Values

OFFSET_BUFFER_TIME

public static final int OFFSET_BUFFER_TIME

The message content offset to the buffer time value

Since:

4.1

See Also:

Constant Field Values

MIN_BUFFER_SIZE

public static final int MIN_BUFFER_SIZE

The minimum value allowed for the buffer size

Since:

4.1

See Also:

Constant Field Values

MAX_BUFFER_SIZE

public static final int MAX_BUFFER_SIZE

The maximum value allowed for the buffer size

Since:

4.1

See Also:

Constant Field Values

MIN_BUFFER_TIME

public static final int MIN_BUFFER_TIME

The minimum value allowed for the buffer time

Since:

4.1

See Also:

Constant Field Values

MAX_BUFFER_TIME

public static final int MAX_BUFFER_TIME

The maximum value allowed for the buffer time

Since:

4.1

See Also:

Constant Field Values

TIME_INCREMENTS

public static final int TIME_INCREMENTS

Buffer Time is specified in 10ms units

Since:

4.1

See Also:

Constant Field Values

DISABLE_EVENT_BUFFERING

public static final ConfigureEventBufferMessage DISABLE_EVENT_BUFFERING

Singleton disable event buffering message.

Constructor Detail

ConfigureEventBufferMessage

public ConfigureEventBufferMessage(ConfigureEventBufferMessage.BufferEvents events,
                           int bufferSize,
                           int bufferTime)

Parameters:

events - Which types of events to buffer. NONE will disable event buffering.

bufferSize - Stores the maximum number of bytes that will be stored before a buffer flush occurs.

bufferTime - Maximum time in 10ms units before a buffer flush occurs. Setting time to 0 disables timer.

Since:

4.1

Method Detail

getBufferEvents

public ConfigureEventBufferMessage.BufferEvents getBufferEvents()

Gets the types of events that will be buffered.

Returns:

The ConfigureEventBufferMessage.BufferEvents that will be buffered.

Since:

4.1

getMaxBufferSizeBeforeFlush

public int getMaxBufferSizeBeforeFlush()

Gets the number of bytes the buffer will hold until flushing all events buffered.

Returns:

The maximum size of the buffer.

Since:

4.1

getMaxBufferTimeBeforeFlush

public int getMaxBufferTimeBeforeFlush()

Gets the duration the buffer will buffer events before flushing all the buffered events.

Returns:

The maximum buffering time, in 10ms units.

Since:

4.1

getRealMaxBufferTimeBeforeFlush

public int getRealMaxBufferTimeBeforeFlush()

Gets the duration events will be buffered for before flushing all events.

Returns:

The maximum buffering time, in milliseconds.

Since:

4.5

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

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

toString

public java.lang.String toString()

Overrides:

toString in class AntMessageFromHost