Symbian^3 Product Developer Library >

TPositionUpdateOptionsBase Class Reference

class TPositionUpdateOptionsBase : public TPositionClassTypeBase

The base class for classes storing position update options

Inherits from

Public Member Functions
IMPORT_C TTimeIntervalMicroSecondsMaxUpdateAge()
IMPORT_C voidSetMaxUpdateAge(TTimeIntervalMicroSeconds)
IMPORT_C voidSetUpdateInterval(TTimeIntervalMicroSeconds)
IMPORT_C voidSetUpdateTimeOut(TTimeIntervalMicroSeconds)
IMPORT_C TTimeIntervalMicroSecondsUpdateInterval()
IMPORT_C TTimeIntervalMicroSecondsUpdateTimeOut()
Protected Member Functions
TPositionUpdateOptionsBase()
TPositionUpdateOptionsBase(TTimeIntervalMicroSeconds, TTimeIntervalMicroSeconds, TTimeIntervalMicroSeconds)
Inherited Functions
TPositionClassTypeBase::PositionClassSize()const
TPositionClassTypeBase::PositionClassType()const
TPositionClassTypeBase::TPositionClassTypeBase()
Protected Attributes
TTimeIntervalMicroSeconds iMaxUpdateAge
TTimeIntervalMicroSeconds iUpdateInterval
TTimeIntervalMicroSeconds iUpdateTimeOut
Private Attributes
TUint8 iReserved
Inherited Attributes
TPositionClassTypeBase::iPosClassSize
TPositionClassTypeBase::iPosClassType

Constructor & Destructor Documentation

TPositionUpdateOptionsBase()

IMPORT_CTPositionUpdateOptionsBase()[protected]

Default constructor for TPositionUpdateOptionsBase

TPositionUpdateOptionsBase(TTimeIntervalMicroSeconds, TTimeIntervalMicroSeconds, TTimeIntervalMicroSeconds)

IMPORT_CTPositionUpdateOptionsBase(TTimeIntervalMicroSecondsaInterval,
TTimeIntervalMicroSecondsaTimeOut =  TTimeIntervalMicroSeconds(0),
TTimeIntervalMicroSecondsaMaxAge =  TTimeIntervalMicroSeconds(0)
)[protected]

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

panic
"LocationClient EPositionBadTime" if aInterval, aMaxAge or aTimeOut is negative.

Parameters

TTimeIntervalMicroSeconds aIntervalThe update interval to be set.
TTimeIntervalMicroSeconds aTimeOut =  TTimeIntervalMicroSeconds(0)The update timeout to be set. Defaults to zero.
TTimeIntervalMicroSeconds aMaxAge =  TTimeIntervalMicroSeconds(0)The maximum update age to be set. Defaults to zero.

Member Functions Documentation

MaxUpdateAge()

IMPORT_C TTimeIntervalMicroSecondsMaxUpdateAge()const

Returns the maximum update age

SetMaxUpdateAge(TTimeIntervalMicroSeconds)

IMPORT_C voidSetMaxUpdateAge(TTimeIntervalMicroSecondsaMaxAge)
sets the maximum update age
panic
"LocationClient EPositionBadTime" if aMaxAge is negative.

Parameters

TTimeIntervalMicroSeconds aMaxAgeThe maximum update age to be set

SetUpdateInterval(TTimeIntervalMicroSeconds)

IMPORT_C voidSetUpdateInterval(TTimeIntervalMicroSecondsaInterval)
Sets update interval
panic
"LocationClient EPositionBadTime" if aInterval is negative.

Parameters

TTimeIntervalMicroSeconds aIntervalThe update interval to be set

SetUpdateTimeOut(TTimeIntervalMicroSeconds)

IMPORT_C voidSetUpdateTimeOut(TTimeIntervalMicroSecondsaTimeOut)
Sets the update timeout
panic
"LocationClient EPositionBadTime" if aTimeOut is negative.

Parameters

TTimeIntervalMicroSeconds aTimeOutThe update timeout to be set

UpdateInterval()

IMPORT_C TTimeIntervalMicroSecondsUpdateInterval()const

Returns the update interval

UpdateTimeOut()

IMPORT_C TTimeIntervalMicroSecondsUpdateTimeOut()const

Returns the update timeout

Member Data Documentation

TTimeIntervalMicroSeconds iMaxUpdateAge

TTimeIntervalMicroSeconds iMaxUpdateAge[protected]

The maximum update age

TUint8 iReserved

TUint8 iReserved[private]

Unused variable for future expansion.

TTimeIntervalMicroSeconds iUpdateInterval

TTimeIntervalMicroSeconds iUpdateInterval[protected]

The update interval

TTimeIntervalMicroSeconds iUpdateTimeOut

TTimeIntervalMicroSeconds iUpdateTimeOut[protected]

The update timeout

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.