Class TPositionUpdateOptions

class TPositionUpdateOptions : public TPositionUpdateOptionsBase;

Description

The normal class for storing position update options. It extends TPositionUpdateOptionsBase, adding methods to allow the option of returning partial updates of data to be specified.

Derivation

• TPositionClassTypeBase - The base class for classes used to store position information

• TPositionUpdateOptionsBase - The base class for classes storing position update options

• TPositionUpdateOptions - The normal class for storing position update options

Members

Defined in TPositionUpdateOptions:
AcceptPartialUpdates(), SetAcceptPartialUpdates(), TPositionUpdateOptions(), TPositionUpdateOptions(), iAcceptPartialUpdates

Inherited from TPositionClassTypeBase:
PositionClassSize(), PositionClassType(), iPosClassSize, iPosClassType

Inherited from TPositionUpdateOptionsBase:
MaxUpdateAge(), SetMaxUpdateAge(), SetUpdateInterval(), SetUpdateTimeOut(), UpdateInterval(), UpdateTimeOut(), iMaxUpdateAge, iUpdateInterval, iUpdateTimeOut

IMPORT_C TPositionUpdateOptions();

Description

Default constructor for TPositionUpdateOptions

IMPORT_C TPositionUpdateOptions(TTimeIntervalMicroSeconds aInterval, TTimeIntervalMicroSeconds aTimeOut=TTimeIntervalMicroSeconds(0), TTimeIntervalMicroSeconds aMaxAge=TTimeIntervalMicroSeconds(0), TBool aAcceptPartialUpdates=EFalse);

Description

Constructor for TPositionUpdateOptions. All parameters except aInterval have default values.

Parameters

TTimeIntervalMicroSeconds aInterval The update interval to be set. TTimeIntervalMicroSeconds aTimeOut The update timeout to be set. Defaults to zero. TTimeIntervalMicroSeconds aMaxAge The maximum update age to be set. Defaults to zero. TBool aAcceptPartialUpdates Whether partial updates will be accepted. Defaults to false.

IMPORT_C void SetAcceptPartialUpdates(TBool aAcceptPartialUpdates);

Description

Sets Whether partial updates will be accepted

Parameters

TBool aAcceptPartialUpdates Whether partial updates will be accepted

IMPORT_C TBool AcceptPartialUpdates() const;

Description

Returns Whether partial updates will be accepted

Return value

TBool ETrue if partial updates are accepted, EFalse otherwise

protected: TBool iAcceptPartialUpdates;

Description

Whether partial updates are accepted