TPositionUpdateOptionsBase Class Reference

#include <lbscommon.h>

Link against: lbs.lib

class TPositionUpdateOptionsBase : public TPositionClassTypeBase

Inherits from

Protected Attributes
TTimeIntervalMicroSeconds iMaxUpdateAge
TTimeIntervalMicroSeconds iUpdateInterval
TTimeIntervalMicroSeconds iUpdateTimeOut
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 Attributes
TPositionClassTypeBase::iPosClassSize
TPositionClassTypeBase::iPosClassType
Inherited Functions
TPositionClassTypeBase::PositionClassSize()const
TPositionClassTypeBase::PositionClassType()const
TPositionClassTypeBase::TPositionClassTypeBase()

Detailed Description

The base class for classes storing position update options

Member Attribute Documentation

iMaxUpdateAge

TTimeIntervalMicroSeconds iMaxUpdateAge[protected]

The maximum update age

iUpdateInterval

TTimeIntervalMicroSeconds iUpdateInterval[protected]

The update interval

iUpdateTimeOut

TTimeIntervalMicroSeconds iUpdateTimeOut[protected]

The update timeout

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.
ParameterDescription
aIntervalThe update interval to be set.
aTimeOutThe update timeout to be set. Defaults to zero.
aMaxAgeThe maximum update age to be set. Defaults to zero.

Member Function Documentation

MaxUpdateAge ( )

IMPORT_C TTimeIntervalMicroSecondsMaxUpdateAge()const

Returns the maximum update age

Returns: The maximum update age

SetMaxUpdateAge ( TTimeIntervalMicroSeconds )

IMPORT_C voidSetMaxUpdateAge(TTimeIntervalMicroSecondsaMaxAge)
sets the maximum update age
panic
"LocationClient EPositionBadTime" if aMaxAge is negative.
ParameterDescription
aMaxAgeThe maximum update age to be set

SetUpdateInterval ( TTimeIntervalMicroSeconds )

IMPORT_C voidSetUpdateInterval(TTimeIntervalMicroSecondsaInterval)
Sets update interval
panic
"LocationClient EPositionBadTime" if aInterval is negative.
ParameterDescription
aIntervalThe update interval to be set

SetUpdateTimeOut ( TTimeIntervalMicroSeconds )

IMPORT_C voidSetUpdateTimeOut(TTimeIntervalMicroSecondsaTimeOut)
Sets the update timeout
panic
"LocationClient EPositionBadTime" if aTimeOut is negative.
ParameterDescription
aTimeOutThe update timeout to be set

UpdateInterval ( )

IMPORT_C TTimeIntervalMicroSecondsUpdateInterval()const

Returns the update interval

Returns: The update interval

UpdateTimeOut ( )

IMPORT_C TTimeIntervalMicroSecondsUpdateTimeOut()const

Returns the update timeout

Returns: The update timeout

© Nokia 2011.