MLbsMovementObserver Class Reference

#include <lbsmovementobserver.h>

List of all members.

Public Member Functions

virtual void HandleMovementUpdate (const TLbsMovementEvent &aEvent)=0
virtual void HandleMovementStatus (TInt aStatus)
virtual TVersion Version () const

Detailed Description

MLbsMovementObserver - Provides callback methods for CLbsLocator to send movement events to the application.

Movement events provide an indication of wherether the user is stationary or moving. Potentially, they may also indicate whether the user is walking.

The range of movement detection supported and the power consumed is dependent on the performance profile being used.

Applications need only to implement the HandleMovementUpdate() method of this class. If status information is important then HandleMovementStatus() should also be defined.

See also:
CLbsLocator
TLbsMovementEvent

Member Function Documentation

void MLbsMovementObserver::HandleMovementStatus ( TInt  aStatus  )  [virtual]

Applications must implement this method to receive movement status updates.

To begin receiving status updates the application must call CLbsLocator::StartUpdatesL().

When HandleMovementStatus() is called with a negative status code, this indicates there has been an error inside the location subsystem or with the connected hardware. These situations are generally not recoverable and the application would normally stop using the interface.

When an application no longer wishes to receive updates it should call CLbsLocator::StopUpdates(). It is possible to call this method from within the HandleLocationStatus() callback.

Parameters:
[in] aStatus A negative value represents a Symbian OS system wide error. This will normally prevent any movement information from being returned. KErrNone is returned when normal service has been restored.
See also:
HandleMovementUpdate
CLbsLocator::StartUpdatesL()
CLbsLocator::StopUpdates()
void MLbsMovementObserver::HandleMovementUpdate ( const TLbsMovementEvent aEvent  )  [pure virtual]

Informs the application of movement events.

To begin receiving updates the application must call CLbsLocator::StartUpdatesL().

After calling StartUpdatesL(), the first update an application will receive is the current movement status if known. The application will then receive movement events but the frequency and information available depends on the active profile. See CLbsLocator::SetLocatorProfile() for more information.

When an application no longer wishes to receive updates it should call CLbsLocator::StopUpdates(). It is legal, valid and usual to stop updates from within the HandleMovementUpdate() callback.

Parameters:
[in] aEvent The current movement indicator.
See also:
TLbsMovementEvent
HandleMovementStatus
CLbsLocator::SetLocatorProfile()
CLbsLocator::StartUpdatesL()
CLbsLocator::StopUpdates()
TVersion MLbsMovementObserver::Version (  )  const [virtual]

This method should not be overridden by the application.

It is queried by the location subsystem to determine the version of the observer interface used by the application.


The documentation for this class was generated from the following files:

Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. These materials are provided under the terms of the Eclipse Public License v1.0.