nn::nex::DataSet::SetMaximumUpdateDelay Member Function

Syntax

static void SetMaximumUpdateDelay(
     TimeInterval tiMaximumUpdateDelay
);

Parameters

Name Description
in tiMaximumUpdateDelay Specifies the maximum update delay to set. The default value is DEFAULT_MAXIMUM_UPDATE_DELAY. NO_MAXIMUM_UPDATE_DELAY is a special value that indicates messages are not automatically sent according to a maximum update delay.

Return Values

None.

Description

Sets the maximum update delay for the dataset.

Note: The data definition language (DDL) compiler generates this function only when the extrapolation_filter property is attached to this dataset in the DDL declaration. The DataSet::SetMaximumUpdateDelay function cannot be used. Use SetMaximumUpdateDelay on declared dataset classes.

When a dataset that uses dead reckoning utilizes an unreliable channel (arrival of network packets is not guaranteed), striking changes in dataset values may occur if message packets are lost during transfer. Use of the maximum update delay solves this type of problem by continuing to send messages to the station in question at set intervals, even assuming that the local estimation model is accurate. The full benefit of setting a maximum update delay is not achieved when dataset updates utilize a reliable channel (arrival of network packets is guaranteed).

The maximum update delay represents the maximum amount of time that can be allowed between updates carried out on a dataset. If a dataset is not updated during the maximum update delay time, a message is automatically sent to the station in question, even if no values have changed since the previous update.

The maximum update delay is a static value. Identical datasets, even different instances, all have the same maximum update delay. However, different datasets may have different maximum update delays.

See Also

GetMaximumUpdateDelay

Revision History

2011/01/28
Initial version.

CONFIDENTIAL