TLbsMovementEvent Class Reference

#include <lbsmovementevent.h>

Inheritance diagram for TLbsMovementEvent:
TLbsLocatorClassTypeBase

List of all members.

Public Types

enum  TLbsMovementEventType {
  EMovementEventUnknown = 0, EMovementEventStationary = 1, EMovementEventMoving = 2, EMovementEventWalking = 4,
  EMovementEventLastBit = 1 << 31
}

Public Member Functions

IMPORT_C TLbsMovementEventType MovementEvent () const
IMPORT_C TTime SystemTimeStamp () const
IMPORT_C void SetMovementEvent (TLbsMovementEventType aEvent)
IMPORT_C TInt SetSystemTimeStamp (TTime aTimeStamp)

Detailed Description

TLbsMovementEvent - Contains the movement status of the device.

To receive movement events, the application must add an movement event observer using CLbsLocator::AddMovementObserverL() and implement the callback method MLbsMovementObserver::HandleMovementUpdate().

To begin receiving updates, the application should call CLbsLocator::StartUpdatesL(). Although this only needs to be called once irrespective of the number or type of observers.

Not all profiles support movement events. Some profiles only support a limited subset of the possible event types. See CLbsLocator::SetLocatorProfile() for information about the movement events supported by each profile.


Member Enumeration Documentation

TLbsMovementEventType - Contain a bit mask of movement event types. For example, the application be notified that both walking and general movement has been detected. Note: This enum may be expanded to include other types of events related to movement.


Member Function Documentation

EXPORT_C TLbsMovementEvent::TLbsMovementEventType TLbsMovementEvent::MovementEvent (  )  const

Retrieves a bit mask of detected movement events.

Returns:
EMovementEventUnknown When no event as been assigned.

see TLbsMovementEventType

EXPORT_C void TLbsMovementEvent::SetMovementEvent ( TLbsMovementEventType  aEvent  ) 

Sets a bit mask of detected movement events.

Parameters:
[in] aEvent A bit mask of detected movement events.
See also:
TLbsMovementEventType
MovementEvent()
EXPORT_C TInt TLbsMovementEvent::SetSystemTimeStamp ( TTime  aTimeStamp  ) 

Sets the system time when the movement event was detected.

Parameters:
[in] aTimeStamp The system time when the movement event was detected. The value cannot be zero.
Returns:
KErrNone If the time stamp has been set.
KErrArgument If the parameter is invalid. For example, a time stamp of zero was supplied.
See also:
SystemTimeStamp()
EXPORT_C TTime TLbsMovementEvent::SystemTimeStamp (  )  const

Retrieves the system time when the movement event was generated.

If the time stamp has not been assigned, a TTime of "zero" will be returned.

Returns:
The time when the movement event was detected.

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.