Symbian^3 Application 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 TTimeIntervalMicroSeconds MaxUpdateAge ()
IMPORT_C void SetMaxUpdateAge ( TTimeIntervalMicroSeconds )
IMPORT_C void SetUpdateInterval ( TTimeIntervalMicroSeconds )
IMPORT_C void SetUpdateTimeOut ( TTimeIntervalMicroSeconds )
IMPORT_C TTimeIntervalMicroSeconds UpdateInterval ()
IMPORT_C TTimeIntervalMicroSeconds UpdateTimeOut ()
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_C TPositionUpdateOptionsBase ( ) [protected]

Default constructor for TPositionUpdateOptionsBase

TPositionUpdateOptionsBase(TTimeIntervalMicroSeconds, TTimeIntervalMicroSeconds, TTimeIntervalMicroSeconds)

IMPORT_C TPositionUpdateOptionsBase ( TTimeIntervalMicroSeconds aInterval,
TTimeIntervalMicroSeconds aTimeOut =  TTimeIntervalMicroSeconds (0),
TTimeIntervalMicroSeconds aMaxAge =  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 aInterval The 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 TTimeIntervalMicroSeconds MaxUpdateAge ( ) const

Returns the maximum update age

SetMaxUpdateAge(TTimeIntervalMicroSeconds)

IMPORT_C void SetMaxUpdateAge ( TTimeIntervalMicroSeconds aMaxAge )
sets the maximum update age
panic
"LocationClient EPositionBadTime" if aMaxAge is negative.

Parameters

TTimeIntervalMicroSeconds aMaxAge The maximum update age to be set

SetUpdateInterval(TTimeIntervalMicroSeconds)

IMPORT_C void SetUpdateInterval ( TTimeIntervalMicroSeconds aInterval )
Sets update interval
panic
"LocationClient EPositionBadTime" if aInterval is negative.

Parameters

TTimeIntervalMicroSeconds aInterval The update interval to be set

SetUpdateTimeOut(TTimeIntervalMicroSeconds)

IMPORT_C void SetUpdateTimeOut ( TTimeIntervalMicroSeconds aTimeOut )
Sets the update timeout
panic
"LocationClient EPositionBadTime" if aTimeOut is negative.

Parameters

TTimeIntervalMicroSeconds aTimeOut The update timeout to be set

UpdateInterval()

IMPORT_C TTimeIntervalMicroSeconds UpdateInterval ( ) const

Returns the update interval

UpdateTimeOut()

IMPORT_C TTimeIntervalMicroSeconds UpdateTimeOut ( ) 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.