Class TPositionUpdateOptionsBase

class TPositionUpdateOptionsBase : public TPositionClassTypeBase;

Description

The base class for classes storing position update options. The options specify an update interval that specifies a client's required frequency of position updates, an update timeout that specifies the length of time that a client is prepared to wait for a position update, and a maximum update age that specifies the maximum age of a position that is acceptable to a client.

Derivation

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

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

Members

Defined in TPositionUpdateOptionsBase:
MaxUpdateAge(), SetMaxUpdateAge(), SetUpdateInterval(), SetUpdateTimeOut(), TPositionUpdateOptionsBase(), TPositionUpdateOptionsBase(), UpdateInterval(), UpdateTimeOut(), iMaxUpdateAge, iUpdateInterval, iUpdateTimeOut

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

protected: IMPORT_C TPositionUpdateOptionsBase();

Description

Default constructor for TPositionUpdateOptionsBase

protected: IMPORT_C TPositionUpdateOptionsBase(TTimeIntervalMicroSeconds aInterval, TTimeIntervalMicroSeconds aTimeOut=TTimeIntervalMicroSeconds(0), TTimeIntervalMicroSeconds aMaxAge=TTimeIntervalMicroSeconds(0));

Description

Constructor for TPositionUpdateOptionsBase. Parameters aTimeOut and aMaxAge have default values of 0.

Parameters

TTimeIntervalMicroSeconds aInterval The required time interval between position updates. TTimeIntervalMicroSeconds aTimeOut The time a client is prepared to wait for a position update. If this value is not set by the client the default value of 0 means that a timeout does not occur for that client. TTimeIntervalMicroSeconds aMaxAge Specifies the maximum acceptable age of position data. The default value of 0 means that new position data is required.

Panic codes

EPositionBadTime If aInterval, aMaxAge or aTimeOut is negative.

IMPORT_C void SetUpdateInterval(TTimeIntervalMicroSeconds aInterval);

Description

Sets update interval

Parameters

TTimeIntervalMicroSeconds aInterval The update interval to be set

Panic codes

EPositionBadTime If aInterval is negative

IMPORT_C void SetUpdateTimeOut(TTimeIntervalMicroSeconds aTimeOut);

Description

Sets the update timeout. Setting this to zero means that a timeout does not occur.

Parameters

TTimeIntervalMicroSeconds aTimeOut The update timeout to be set

Panic codes

EPositionBadTime If aTimeOut is negative

IMPORT_C void SetMaxUpdateAge(TTimeIntervalMicroSeconds aMaxAge);

Description

sets the maximum update age

Parameters

TTimeIntervalMicroSeconds aMaxAge The maximum update age to be set

Panic codes

EPositionBadTime If aMaxAge is negative

IMPORT_C TTimeIntervalMicroSeconds UpdateInterval() const;

Description

Returns the update interval

Return value

TTimeIntervalMicroSeconds The update interval

IMPORT_C TTimeIntervalMicroSeconds UpdateTimeOut() const;

Description

Returns the update timeout

Return value

TTimeIntervalMicroSeconds The update timeout

IMPORT_C TTimeIntervalMicroSeconds MaxUpdateAge() const;

Description

Returns the maximum update age

Return value

TTimeIntervalMicroSeconds The maximum update age

protected: TTimeIntervalMicroSeconds iUpdateInterval;

Description

The update interval

protected: TTimeIntervalMicroSeconds iUpdateTimeOut;

Description

The update timeout

protected: TTimeIntervalMicroSeconds iMaxUpdateAge;

Description

The maximum update age