TPositionCriteriaBase Class Reference

#include <lbscriteria.h>

Link against: lbs.lib

class TPositionCriteriaBase : public TPositionClassTypeBase

Inherits from

Protected Attributes
TPositionModuleInfo::TCapabilities iRequiredCaps
TPositionQuality iRequiredQuality
TPositionSelectionOrder iSelectionOrder
Public Member Functions
IMPORT_C voidAddRequiredCapabilities(TPositionModuleInfo::TCapabilities)
IMPORT_C voidClearCriteria()
IMPORT_C voidClearRequiredCapabilities()
IMPORT_C voidGetRequiredQuality(TPositionQuality &)
IMPORT_C voidGetSelectionOrder(TPositionSelectionOrder &)
IMPORT_C TPositionModuleInfo::TCapabilitiesRequiredCapabilities()
IMPORT_C voidResetCriteria()
IMPORT_C voidSetRequiredQuality(const TPositionQuality &)
IMPORT_C voidSetSelectionOrder(const TPositionSelectionOrder &)
Protected Member Functions
TPositionCriteriaBase()
TPositionCriteriaBase(TPositionModuleInfo::TCapabilities)
Inherited Attributes
TPositionClassTypeBase::iPosClassSize
TPositionClassTypeBase::iPosClassType
Inherited Functions
TPositionClassTypeBase::PositionClassSize()const
TPositionClassTypeBase::PositionClassType()const
TPositionClassTypeBase::TPositionClassTypeBase()

Detailed Description

The base class for classes used to store position module selection criteria information.

Member Attribute Documentation

iRequiredCaps

TPositionModuleInfo::TCapabilities iRequiredCaps[protected]

The capabilities a positioning module must have.

iRequiredQuality

TPositionQuality iRequiredQuality[protected]

The quality required of a positioning module.

iSelectionOrder

TPositionSelectionOrder iSelectionOrder[protected]

The priorities assigned to the various quality metrics.

Constructor & Destructor Documentation

TPositionCriteriaBase ( )

IMPORT_CTPositionCriteriaBase()[protected]

Constructor for the abstract base class TPositionCriteriaBase

TPositionCriteriaBase ( TPositionModuleInfo::TCapabilities )

IMPORT_CTPositionCriteriaBase(TPositionModuleInfo::TCapabilitiesaCapabilityMask)[protected]

Constructor for TPositionCriteriaBase that specifies mandatory additional capabilities of the positioning module used to provide the application with position information.

ParameterDescription
aCapabilityMaskis a bit mask of values from the enumeration TPositionModuleInfo::_TCapabilities. Defaults to TPositionModuleInfo::ECapabilityHorizontal.

Member Function Documentation

AddRequiredCapabilities ( TPositionModuleInfo::TCapabilities )

IMPORT_C voidAddRequiredCapabilities(TPositionModuleInfo::TCapabilitiesaCapabilityMask)

Specifies mandatory additional capabilities of the positioning module used to provide the application with position information.

ParameterDescription
aCapabilityMaskis a bit mask of values from the enumeration TPositionModuleInfo::_TCapabilities.

ClearCriteria ( )

IMPORT_C voidClearCriteria()

Removes all criteria including the default values. This includes all required capabilities, all quality of position information and all selection ordering details. This is useful if horizontal position information is not required by the application.

ClearRequiredCapabilities ( )

IMPORT_C voidClearRequiredCapabilities()

Clears the mandatory additional capabilities of the positioning module used to provide the application with position information.

GetRequiredQuality ( TPositionQuality & )

IMPORT_C voidGetRequiredQuality(TPositionQuality &aPosQuality)const

Returns any currently specified quality limits.

ParameterDescription
aPosQualitywill be set to the required quality of positioning information.

GetSelectionOrder ( TPositionSelectionOrder & )

IMPORT_C voidGetSelectionOrder(TPositionSelectionOrder &aSelectionOrder)const

Retrieves the current selection order that will be used by the positioning server in selecting a positioning module.

ParameterDescription
aSelectionOrderwill be set to the current selection ordering.

RequiredCapabilities ( )

IMPORT_C TPositionModuleInfo::TCapabilitiesRequiredCapabilities()const

Returns the current set of required criteria including the default.

Returns: the current set of required criteria including the default.

ResetCriteria ( )

IMPORT_C voidResetCriteria()

Used to restore the criteria to the default values. This includes the required capabilities, quality of position information and selection ordering details.

SetRequiredQuality ( const TPositionQuality & )

IMPORT_C voidSetRequiredQuality(const TPositionQuality &aPosQuality)

Used to specify the mandatory upper bound for the quality of information that the application will accept.

ParameterDescription
aPosQualityis the new required quality of positioning information.

SetSelectionOrder ( const TPositionSelectionOrder & )

IMPORT_C voidSetSelectionOrder(const TPositionSelectionOrder &aSelectionOrder)

Sets the selection order to be used by the positioning server in selecting a positioning module.

ParameterDescription
aSelectionOrderis the new selection ordering to be used.
© Nokia 2011.