Collapse all Symbian^3 Product Developer Library

TPositionCriteriaBase Class Reference

class TPositionCriteriaBase : public TPositionClassTypeBase

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

Inherits from

TPositionCriteriaBase
- TPositionClassTypeBase

Public Member Functions
IMPORT_C void	AddRequiredCapabilities(TPositionModuleInfo::TCapabilities)
IMPORT_C void	ClearCriteria()
IMPORT_C void	ClearRequiredCapabilities()
IMPORT_C void	GetRequiredQuality(TPositionQuality &)
IMPORT_C void	GetSelectionOrder(TPositionSelectionOrder &)
IMPORT_C TPositionModuleInfo::TCapabilities	RequiredCapabilities()
IMPORT_C void	ResetCriteria()
IMPORT_C void	SetRequiredQuality(const TPositionQuality &)
IMPORT_C void	SetSelectionOrder(const TPositionSelectionOrder &)

Protected Member Functions
	TPositionCriteriaBase()
	TPositionCriteriaBase(TPositionModuleInfo::TCapabilities)

Inherited Functions
	TPositionClassTypeBase::PositionClassSize()const
	TPositionClassTypeBase::PositionClassType()const
	TPositionClassTypeBase::TPositionClassTypeBase()

Protected Attributes
TPositionModuleInfo::TCapabilities	iRequiredCaps
TPositionQuality	iRequiredQuality
TPositionSelectionOrder	iSelectionOrder

Inherited Attributes
	TPositionClassTypeBase::iPosClassSize
	TPositionClassTypeBase::iPosClassType

Constructor & Destructor Documentation

TPositionCriteriaBase()

IMPORT_C

TPositionCriteriaBase

(

)

[protected]

Constructor for the abstract base class TPositionCriteriaBase

TPositionCriteriaBase(TPositionModuleInfo::TCapabilities)

IMPORT_C

TPositionCriteriaBase

(

TPositionModuleInfo::TCapabilities

aCapabilityMask

)

[protected]

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

Parameters

TPositionModuleInfo::TCapabilities aCapabilityMask

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

Member Functions Documentation

AddRequiredCapabilities(TPositionModuleInfo::TCapabilities)

IMPORT_C void

AddRequiredCapabilities

(

TPositionModuleInfo::TCapabilities

aCapabilityMask

)

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

Parameters

TPositionModuleInfo::TCapabilities aCapabilityMask

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

ClearCriteria()

IMPORT_C void

ClearCriteria

(

)

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 void

ClearRequiredCapabilities

(

)

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

GetRequiredQuality(TPositionQuality &)

IMPORT_C void

GetRequiredQuality

(

TPositionQuality &

aPosQuality

)

const

Returns any currently specified quality limits.

Parameters

TPositionQuality & aPosQuality

will be set to the required quality of positioning information.

GetSelectionOrder(TPositionSelectionOrder &)

IMPORT_C void

GetSelectionOrder

(

TPositionSelectionOrder &

aSelectionOrder

)

const

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

Parameters

TPositionSelectionOrder & aSelectionOrder

will be set to the current selection ordering.

RequiredCapabilities()

IMPORT_C TPositionModuleInfo::TCapabilities

RequiredCapabilities

(

)

const

Returns the current set of required criteria including the default.

ResetCriteria()

IMPORT_C void

ResetCriteria

(

)

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 void

SetRequiredQuality

(

const TPositionQuality &

aPosQuality

)

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

Parameters

const TPositionQuality & aPosQuality

is the new required quality of positioning information.

SetSelectionOrder(const TPositionSelectionOrder &)

IMPORT_C void

SetSelectionOrder

(

const TPositionSelectionOrder &

aSelectionOrder

)

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

Parameters

const TPositionSelectionOrder & aSelectionOrder

is the new selection ordering to be used.

Member Data Documentation

TPositionModuleInfo::TCapabilities iRequiredCaps

TPositionModuleInfo::TCapabilities

iRequiredCaps

[protected]

The capabilities a positioning module must have.

TPositionQuality iRequiredQuality

TPositionQuality

iRequiredQuality

[protected]

The quality required of a positioning module.

TPositionSelectionOrder iSelectionOrder

TPositionSelectionOrder

iSelectionOrder

[protected]

The priorities assigned to the various quality metrics.