TPositionUpdateOptionsBase in LOCATIONFRAMEWORK

class TPositionUpdateOptionsBase : public TPositionClassTypeBase;

Description

The base class for classes storing position update options

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. 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.

Panic codes

"LocationClient

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

"LocationClient

EPositionBadTime" if aInterval is negative.

IMPORT_C void SetUpdateTimeOut(TTimeIntervalMicroSeconds aTimeOut);

Description

Sets the update timeout

Parameters


TTimeIntervalMicroSeconds aTimeOut

The update timeout to be set

Panic codes

"LocationClient

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

"LocationClient

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

Class `TPositionUpdateOptionsBase`

Description

Derivation

Members

Construction and destruction