#include <LbsCriteria.h>
Link against: lbs.lib
Link against: lbsselflocate.lib

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

Members

Defined in TPositionCriteriaBase:

ClearCriteria()Removes all criteria including the default values. This includes all required ca...
ClearRequiredCapabilities()Clears the mandatory additional capabilities of the positioning module used to p...
GetRequiredQuality(TPositionQuality &)constReturns any currently specified quality limits.
GetSelectionOrder(TPositionSelectionOrder &)constRetrieves the current selection order that will be used by the positioning serve...
RequiredCapabilities()constReturns the current set of required criteria including the default.
ResetCriteria()Used to restore the criteria to the default values. This includes the required c...
SetRequiredQuality(const TPositionQuality &)Used to specify the mandatory upper bound for the quality of information that th...
SetSelectionOrder(const TPositionSelectionOrder &)Sets the selection order to be used by the positioning server in selecting a pos...
TPositionCriteriaBase()Constructor for the abstract base class TPositionCriteriaBase
iRequiredCapsThe capabilities a positioning module must have.
iRequiredQualityThe quality required of a positioning module.
iSelectionOrderThe priorities assigned to the various quality metrics.

Inherited from TPositionClassTypeBase:

PositionClassSize()constPositionClassSize
PositionClassType()constPositionClassTypeType
iPosClassSizeThe size of the derived class
iPosClassTypeThe type of the derived class

Construction and destruction

`TPositionCriteriaBase()`

protected: IMPORT_C TPositionCriteriaBase();

Description

Constructor for the abstract base class TPositionCriteriaBase

`TPositionCriteriaBase(TPositionModuleInfo::TCapabilities)`

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.

Member functions

`AddRequiredCapabilities(TPositionModuleInfo::TCapabilities)`

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.

`ClearRequiredCapabilities()`

IMPORT_C void ClearRequiredCapabilities();

Description

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

`RequiredCapabilities()const`

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.

`SetRequiredQuality(const TPositionQuality &)`

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.

`GetRequiredQuality(TPositionQuality &)const`

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.

`SetSelectionOrder(const TPositionSelectionOrder &)`

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.

`GetSelectionOrder(TPositionSelectionOrder &)const`

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.

`ResetCriteria()`

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.

`ClearCriteria()`

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.

Member data

`iRequiredCaps`

protected: TPositionModuleInfo::TCapabilities iRequiredCaps;

Description

The capabilities a positioning module must have.

`iRequiredQuality`

protected: TPositionQuality iRequiredQuality;

Description

The quality required of a positioning module.

`iSelectionOrder`

protected: TPositionSelectionOrder iSelectionOrder;

Description

The priorities assigned to the various quality metrics.

Class TPositionCriteriaBase

Description

Derivation

Members

Construction and destruction

TPositionCriteriaBase()

Description

TPositionCriteriaBase(TPositionModuleInfo::TCapabilities)

Description

Parameters

Member functions

AddRequiredCapabilities(TPositionModuleInfo::TCapabilities)

Description

Parameters

ClearRequiredCapabilities()

Description

RequiredCapabilities()const

Description

Return value

SetRequiredQuality(const TPositionQuality &)

Description

Parameters

GetRequiredQuality(TPositionQuality &)const

Description

Parameters

SetSelectionOrder(const TPositionSelectionOrder &)

Description

Parameters

GetSelectionOrder(TPositionSelectionOrder &)const

Description

Parameters

ResetCriteria()

Description

ClearCriteria()

Description

Member data

iRequiredCaps

Description

iRequiredQuality

Description

iSelectionOrder

Description

Class `TPositionCriteriaBase`

`TPositionCriteriaBase()`

`TPositionCriteriaBase(TPositionModuleInfo::TCapabilities)`

`AddRequiredCapabilities(TPositionModuleInfo::TCapabilities)`

`ClearRequiredCapabilities()`

`RequiredCapabilities()const`

`SetRequiredQuality(const TPositionQuality &)`

`GetRequiredQuality(TPositionQuality &)const`

`SetSelectionOrder(const TPositionSelectionOrder &)`

`GetSelectionOrder(TPositionSelectionOrder &)const`

`ResetCriteria()`

`ClearCriteria()`

`iRequiredCaps`

`iRequiredQuality`

`iSelectionOrder`