Class TPositionCriteriaBase

class TPositionCriteriaBase : public TPositionClassTypeBase;

Description

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

Derivation

• TPositionClassTypeBase - The base class for classes used to store position information

• TPositionCriteriaBase - The base class for classes used to store position module selection criteria information

Members

Defined in TPositionCriteriaBase:
AddRequiredCapabilities(), ClearCriteria(), ClearRequiredCapabilities(), GetRequiredQuality(), GetSelectionOrder(), RequiredCapabilities(), ResetCriteria(), SetRequiredQuality(), SetSelectionOrder(), TPositionCriteriaBase(), TPositionCriteriaBase(), iRequiredCaps, iRequiredQuality, iSelectionOrder

Inherited from TPositionClassTypeBase:
PositionClassSize(), PositionClassType(), iPosClassSize, iPosClassType

protected: IMPORT_C TPositionCriteriaBase();

Description

Constructor for the abstract base class TPositionCriteriaBase

protected: IMPORT_C TPositionCriteriaBase(TPositionModuleInfo::TCapabilities aCapabilityMask);

Description

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.

IMPORT_C void AddRequiredCapabilities(TPositionModuleInfo::TCapabilities aCapabilityMask);

Description

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.

IMPORT_C void ClearRequiredCapabilities();

Description

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

IMPORT_C TPositionModuleInfo::TCapabilities RequiredCapabilities() const;

Description

Returns the current set of required criteria including the default.

Return value

TPositionModuleInfo::TCapabilities the current set of required criteria including the default.

IMPORT_C void SetRequiredQuality(const TPositionQuality &aPosQuality);

Description

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.

IMPORT_C void GetRequiredQuality(TPositionQuality &aPosQuality) const;

Description

Returns any currently specified quality limits.

Parameters

TPositionQuality &aPosQuality will be set to the required quality of positioning information.

IMPORT_C void SetSelectionOrder(const TPositionSelectionOrder &aSelectionOrder);

Description

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.

IMPORT_C void GetSelectionOrder(TPositionSelectionOrder &aSelectionOrder) const;

Description

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.

IMPORT_C void ResetCriteria();

Description

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

IMPORT_C void ClearCriteria();

Description

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.

protected: TPositionModuleInfo::TCapabilities iRequiredCaps;

Description

The capabilities a positioning module must have.

protected: TPositionQuality iRequiredQuality;

Description

The quality required of a positioning module.

protected: TPositionSelectionOrder iSelectionOrder;

Description

The priorities assigned to the various quality metrics.