nn::nex::DataSet::SetMinimumUpdateDelay Member Function

Syntax

static void SetMinimumUpdateDelay(
     TimeInterval tiMinimumUpdateDelay
);

Parameters

Name Description
in tiMinimumUpdateDelay Specifies the minimum update delay to set. The default is DEFAULT_MINIMUM_UPDATE_DELAY. Specifying NO_MINIMUM_UPDATE_DELAY indicates that updates are not destroyed according to a minimum delay time.

Return Values

None.

Description

Sets the minimum update delay for this 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::SetMinimumUpdateDelay function cannot be used. Use SetMinimumUpdateDelay on declared dataset classes.

If the error tolerance (ErrorToleranceFunction) defined for a dataset that uses dead reckoning is low, frequent updates may put a great strain on network bandwidth. Application developers can specify the maximum frequency at which to update datasets by setting this minimum update delay.

The minimum update delay represents the minimum amount of time allowed for updating a dataset. Datasets are not updated until this minimum update delay has elapsed. If the DuplicatedObject::Update function is called more frequently than the minimum time set here, the DuplicatedObject::Update function call will be ignored. However, this is not true when there has been a continuity break (IndicateContinuityBreak()).

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

See Also

GetMinimumUpdateDelay

Revision History

2011/01/28
Initial version.

CONFIDENTIAL