TPositionUpdateOptionsBase Class Reference

#include <lbscommon.h>

Link against: lbs.lib

class TPositionUpdateOptionsBase : public TPositionClassTypeBase, public TPositionClassTypeBase

Inherits from

TPositionUpdateOptionsBase
- TPositionClassTypeBase
- TPositionClassTypeBase

Protected Attributes
TTimeIntervalMicroSeconds	iMaxUpdateAge
TTimeIntervalMicroSeconds	iUpdateInterval
TTimeIntervalMicroSeconds	iUpdateTimeOut

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

Parameters
aInterval	The update interval to be set.
aTimeOut	The update timeout to be set. Defaults to zero.
aMaxAge	The maximum update age to be set. Defaults to zero.

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

Member Function Documentation

MaxUpdateAge ( )

IMPORT_C TTimeIntervalMicroSeconds

MaxUpdateAge

(

)

const

Returns the maximum update age

Return Value: The maximum update age

SetMaxUpdateAge ( TTimeIntervalMicroSeconds )

IMPORT_C void

SetMaxUpdateAge

(

TTimeIntervalMicroSeconds

aMaxAge

)

sets the maximum update age

Parameters
aMaxAge	The maximum update age to be set

Panic Codes
"LocationClient	EPositionBadTime" if aMaxAge is negative.

SetUpdateInterval ( TTimeIntervalMicroSeconds )

IMPORT_C void

SetUpdateInterval

(

TTimeIntervalMicroSeconds

aInterval

)

Sets update interval

Parameters
aInterval	The update interval to be set

Panic Codes
"LocationClient	EPositionBadTime" if aInterval is negative.

SetUpdateTimeOut ( TTimeIntervalMicroSeconds )

IMPORT_C void

SetUpdateTimeOut

(

TTimeIntervalMicroSeconds

aTimeOut

)

Sets the update timeout

Parameters
aTimeOut	The update timeout to be set

Panic Codes
"LocationClient	EPositionBadTime" if aTimeOut is negative.

UpdateInterval ( )

IMPORT_C TTimeIntervalMicroSeconds

UpdateInterval

(

)

const

Returns the update interval

Return Value: The update interval

UpdateTimeOut ( )

IMPORT_C TTimeIntervalMicroSeconds

UpdateTimeOut

(

)

const

Returns the update timeout

Return Value: The update timeout