nn::nex::DataSet Class

Syntax

class DataSet : public nn::nex::RootObject

Description

Represents datasets of duplicated objects.

DataSet represents a group of values holding several common update policies defined by the data definition language (DDL). You can think of it as a type of data structure like that used in the C++ programming language. This class is a base class for the application-specific dataset class hierarchy generated by the DDL declaration. When the duplication master (DuplicatedObject::IsADuplicationMaster()) calls the DuplicatedObject::Update function, all datasets included in duplicas of the duplicated objects are updated according to the update policy defined by the DLL.

Note that many instances of this function are generated if DDL properties given in the DDL declaration of the dataset are included. A compiler error therefore results when a function listed here is called, but the associated DDL property is not declared in the DDL file. For example, the SetModel function cannot be used because it is not generated unless the DDL property named extrapolation_filter is declared.

Use the OperationBegin and OperationEnd functions if you want to implement a cheat detection feature by performing a precheck based on maximum variable values given for a dataset. In most cases, to determine whether to accept a value, you can use the OperationBegin function to load and store current dataset values, and then use the OperationEnd to look at new values. In addition, if the dataset utilizes supplementation, you can easily calculate the rate of change of a value based on the supplementation point being saved.

Member Functions

SetModel Sets a new supplementation model on the duplication master.
SetLocalCorrection Sets a new supplementation model for the duplica on the local station.
GetRevision Gets the revision number of a received data set.
DataSet Do not call this constructor from applications.
V ~DataSet Do not call this destructor from applications.
UpdateIsRequired Selects the station whose dataset is to be updated.
ReliableUpdate Returns whether the dataset will be updated using a reliable channel.
OperationBegin Called by the system when DOOperation will have an effect on a dataset.
OperationEnd Called by the system after DOOperation has had an effect on a dataset.
RequestUpdate At the time of the next update, notification is made that proper execution is required.
IndicateContinuityBreak Notifies that dataset values have changed in a non-continuous manner.
PredictValue Predicts and gets a dead reckoning value based on current information.
PredictRateOfChange Predicts the rate of change in variables for which dead reckoning is being used based on current information and returns the result.
SetLoopbackSamplingInterval Sets a loopback sampling interval.
UpdateLoopback Updates LOOPBACKMODEL with the current dataset value.
RefreshLoopback Recalculates LOOPBACKMODEL with the updated values.
PredictLoopbackValue Predicts the loopback value for the specified time from the loopback model.
SetSubStreamID Specifies the SubStreamID used during reliable sending.
GetSubStreamID Gets the SubStreamID used during reliable sending.
GetRecvSubStreamID Gets the SubStreamID used during reliable reception.
S GetPHBDRParameters Gets a pointer to the dead reckoning parameter for this dataset class.
S GetErrorToleranceFunction Gets a pointer to the ErrorToleranceFunction for this dataset.
S SetMaximumUpdateDelay Sets the maximum update delay for the dataset.
S GetMaximumUpdateDelay Gets the maximum update delay time for the dataset.
S SetMinimumUpdateDelay Sets the minimum update delay for this dataset.
S GetMinimumUpdateDelay Gets the minimum update delay for this dataset.
S SetLoopbackDelay Sets the loopback delay time for dataset.
S GetLoopbackDelay Gets the loopback delay time for dataset.
S GetLoopbackSamplingInterval Gets the loopback sampling interval.

Class Hierarchy

nn::nex::RootObject
  nn::nex::DataSet

Revision History

2011/01/27
Initial version.

CONFIDENTIAL