nn::nex::DataSet::PredictValue Member Function

Syntax

qFloat PredictValue(
     PHBDRVar_qInt32 & v,
     Time tPredictionTime = SessionClock::GetTime()
);

Parameters

Name Description
in v Specifies the dataset variable for which to get the predicted value. This value can be obtained using the MODEL macro.
in tPredictionTime Specifies the time for which to get the predicted value. This is the current session time by default.

Return Values

Returns a predicted value.

Description

Predicts and gets a dead reckoning value based on current information.

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.

This function can only be used on a duplica. (To verify, call the DuplicatedObject::IsADuplica function.) Call this function to obtain the predicted dataset values (provided using the MODEL macro) for the specified time. Dead reckoning prediction is performed based on current dataset values. Predictions change as new information arrives from the duplication master.

SYSTEMERROR_OBJDUP_INVALID_ON_MASTER is signaled when this function is executed on a dataset belonging to a duplication master. (To verify use the DuplicatedObject::IsADuplicationMaster function). SYSTEMERROR_GEN_INVALID_OPERATION is signaled when this function is executed on a dataset that does not use dead reckoning.

See Also

SessionClock::GetTime()

Revision History

2012/01/27
Initial version.

CONFIDENTIAL