TPositionCriteriaBase Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

None

Exceptions

The capability Location is required in:

TInt RPositionServer::GetDefaultModuleId(TPositionModuleId& aModuleId) const;

TInt RPositionServer::GetNumModules(TUint& aNumModules) const;

TInt RPositionServer::GetModuleInfoByIndex(TInt aModuleIndex, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleInfoById(TPositionModuleId aModuleId, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleStatus(TPositionModuleStatusBase& aPosModuleStatus, TPositionModuleId aModuleId) const;

void RPositionServer::NotifyModuleStatusEvent(TPositionModuleStatusEventBase& aStatusEvent,TRequestStatus& aStatus,const TPositionModuleId aModuleId = KPositionNullModuleId) const;

TInt RPositioner::SetRequestor(CRequestor::TRequestorType aType,CRequestor::TRequestorFormat aFormat,const TDesC& aData);

TInt RPositioner::SetRequestor(const RRequestorStack& aRequestorStack);

TInt RPositioner::SetUpdateOptions(const TPositionUpdateOptionsBase& aPosOption);

TInt RPositioner::GetUpdateOptions(TPositionUpdateOptionsBase& aPosOption) const;

void RPositioner::GetLastKnownPosition(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

void RPositioner::NotifyPositionUpdate(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

#include <lbscriteria.h>

Inherits TPositionClassTypeBase.

Inherited by TPositionCriteria.

Detailed Description

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

Public Member Functions
IMPORT_C void  AddRequiredCapabilities (TPositionModuleInfo::TCapabilities aCapabilityMask)
  Specifies mandatory additional capabilities of the positioning module used to provide the application with position information.
IMPORT_C void  ClearRequiredCapabilities ()
  Clears the mandatory additional capabilities of the positioning module used to provide the application with position information.
IMPORT_C TPositionModuleInfo::TCapabilities  RequiredCapabilities () const
  Returns the current set of required criteria including the default.
IMPORT_C void  SetRequiredQuality (const TPositionQuality &aPosQuality)
  Set the mandatory upper bound for the quality of information that the application will accept.
IMPORT_C void  GetRequiredQuality (TPositionQuality &aPosQuality) const
  Get any currently specified quality limits.
IMPORT_C void  SetSelectionOrder (const TPositionSelectionOrder &aSelectionOrder)
  Sets the selection order to be used by the positioning server in selecting a positioning module.
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.
IMPORT_C void  ResetCriteria ()
  Used to restore the criteria to the default values.
IMPORT_C void  ClearCriteria ()
  Removes all criteria including the default values.

Protected Member Functions
IMPORT_C  TPositionCriteriaBase ()
  Default constructor.
IMPORT_C  TPositionCriteriaBase (TPositionModuleInfo::TCapabilities aCapabilityMask)
  constructor with capabilities input.

Protected Attributes
TPositionModuleInfo::TCapabilities  iRequiredCaps
  The capabilities a positioning module must have.
TPositionQuality  iRequiredQuality
  The quality required of a positioning module.
TPositionSelectionOrder  iSelectionOrder
  The priorities assigned to the various quality metrics.

Constructor & Destructor Documentation

IMPORT_C TPositionCriteriaBase::TPositionCriteriaBase (   )  [protected]
 

Default constructor.

IMPORT_C TPositionCriteriaBase::TPositionCriteriaBase (  TPositionModuleInfo::TCapabilities  aCapabilityMask  )  [protected]
 

constructor with capabilities input.

Parameters:
aCapabilityMask  a bitmask of values form the enumeration TPositionModuleInfo::_TCapabilities that specifies the capabilites requested by the client from the positioning module.

Member Function Documentation

IMPORT_C void TPositionCriteriaBase::AddRequiredCapabilities (  TPositionModuleInfo::TCapabilities  aCapabilityMask  ) 
 

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

Parameters:
aCapabilityMask  is a bit mask of values from the enumeration TPositionModuleInfo::_TCapabilities.
IMPORT_C void TPositionCriteriaBase::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.

IMPORT_C void TPositionCriteriaBase::ClearRequiredCapabilities (   ) 
 

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

IMPORT_C void TPositionCriteriaBase::GetRequiredQuality (  TPositionQuality &  aPosQuality  )  const
 

Get any currently specified quality limits.

Parameters:
[out]  aPosQuality  will be set to the required quality of positioning information.
IMPORT_C void TPositionCriteriaBase::GetSelectionOrder (  TPositionSelectionOrder &  aSelectionOrder  )  const
 

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

Parameters:
[out]  aSelectionOrder  will be set to the current selection ordering.
IMPORT_C TPositionModuleInfo::TCapabilities TPositionCriteriaBase::RequiredCapabilities (   )  const
 

Returns the current set of required criteria including the default.

Returns:
the current set of required criteria including the default.
IMPORT_C void TPositionCriteriaBase::ResetCriteria (   ) 
 

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 TPositionCriteriaBase::SetRequiredQuality (  const TPositionQuality &  aPosQuality  ) 
 

Set the mandatory upper bound for the quality of information that the application will accept.

Parameters:
[in]  aPosQuality  is the new required quality of positioning information.
IMPORT_C void TPositionCriteriaBase::SetSelectionOrder (  const TPositionSelectionOrder &  aSelectionOrder  ) 
 

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

Parameters:
[in]  aSelectionOrder  is the new selection ordering to be used.

Field Documentation

TPositionModuleInfo::TCapabilities TPositionCriteriaBase::iRequiredCaps [protected]
 

The capabilities a positioning module must have.

TPositionQuality TPositionCriteriaBase::iRequiredQuality [protected]
 

The quality required of a positioning module.

TPositionSelectionOrder TPositionCriteriaBase::iSelectionOrder [protected]
 

The priorities assigned to the various quality metrics.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top