Class List

+ + + + + + + + + + + + + + + + + + +

Public Types
enum	TLbsLocatorOption { ELocatorStatusTimer = 1 + }
Public Member Functions
IMPORT_C	~CLbsLocator ()
IMPORT_C TInt	SetLocatorProfile (TUid aProfileId)
IMPORT_C TUid	LocatorProfile () const
IMPORT_C void	StartUpdatesL ()
IMPORT_C void	StopUpdates ()
IMPORT_C TInt	SetLocatorOption (TLbsLocatorOption aOption, TInt aValue)
IMPORT_C TInt	GetLocatorOption (TLbsLocatorOption aOption, TInt &aValue) const
IMPORT_C void	AddLocationObserverL (MLbsLocationObserver &aObserver)
IMPORT_C TInt	RemoveLocationObserver (MLbsLocationObserver &aObserver)
IMPORT_C void	AddMovementObserverL (MLbsMovementObserver &aObserver)
IMPORT_C TInt	RemoveMovementObserver (MLbsMovementObserver &aObserver)
Static Public Member Functions
static IMPORT_C CLbsLocator *	NewL ()
static IMPORT_C CLbsLocator *	NewL (MLbsLocationObserver &aObserver)

Detailed Description

CLbsLocator - Interface class to request location and movement information.

After creating a new instance of the interface via one of the NewL() methods, applications should set their desired profile using SetLocatorProfile(). To begin receiving updates, the StartUpdatesL() method must be called.

The frequency and accuracy of these updates and the power consumed is dependent on the profile being used.

Updates are sent to one or more Observers. The MLbsLocationObserver class is used to receive location updates (i.e. containing latitude and longitude). The MLbsMovementObserver class is used to receive events related to the movement of the device (for example stationary or moving).

A location observer may be supplied via the NewL() but observers can also be added using AddLocationObserverL() and AddMovementObserverL(). It is possible to have multiple observers for each type of update.

At least one observer should be present before the application calls StartUpdatesL().

Applications must have the Location capability to receive location updates.

See also:: MLbsLocationObserver; +MLbsMovementObserver

Member Enumeration Documentation

+ +

+ + + + +

enum CLbsLocator::TLbsLocatorOption

Used a parameter to SetLocatorOption() to tailor the behaviour of the active profile. When the profile is changed, any previously modified option is returned to the default.

See also:: SetLocatorOption(); +GetLocatorOption()

Enumerator:

+ +

ELocatorStatusTimer

Controls when status updates are generated.

+ +

Constructor & Destructor Documentation

+ +

+ + + + + + + + +

EXPORT_C CLbsLocator::~CLbsLocator ( )

Closes all open resources and stops updates being sent to the application.

If an application wishes to temporarily halt updates it should use the StopUpdates() method.

The destructor is normally called as the application is closing down. It is not a requirement to call StopUpdates() before deleting the interface but it is recommended to do so.

Note: The destructor must not be invoked during any form of callback from the interface to one of the application's observers. For example during a location or movement update. This is a programming error and is likely to result in an application crash.

It is however possible and legal to call StopUpdates() during an update callback.

See also:: StopUpdates()

+ +

Member Function Documentation

+ +

+ + + + + + + + + +

EXPORT_C void CLbsLocator::AddLocationObserverL ( MLbsLocationObserver & aObserver )

Adds a Location Observer.

The specified observer will start to receive location updates when they are next generated. It is possible to have multiple location observers.

Location observers can be specified using AddLocationObserverL() or (optionally) when the interface class is created via the NewL(MLbsLocationObserver& aObserver) overload. To begin receiving updates the application must first call StartUpdatesL().

Observers can be added before or after StartUpdatesL() is called. If an observer is after updates have been started it will automatically receive the next location update.

Attempting to add an observer that is already present has no effect. That is, duplicate observers are not added but the method does not leave.

Location observers can be removed using RemoveLocationObserver().

In order to add a location observer, the application must have the Location capability. Otherwise, this method will Leave with the error KErrPermissionDenied.

The observer will not be added if the method leaves.

Parameters:

+ + +

[in] aObserver The observer to be added.

KErrPermissionDenied When the application does not have the Location capability. KErrNoMemory If there has been a memory allocation problem. OtherStatusCode When if some other issue prevents the observer being added Location

See also:: StartUpdatesL(); +NewL(MLbsLocationObserver& aObserver); +RemoveLocationObserver()

+ +

+ + + + + + + + + +

EXPORT_C void CLbsLocator::AddMovementObserverL ( MLbsMovementObserver & aObserver )

Adds a Movement Observer.

The specified observer will start to receive movement event updates when they are next generated. It is possible to have multiple movement observers and no location observers.

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

Observers can be added before or after StartUpdatesL() is called. If an observer is after updates have been started it will automatically receive the next movement update.

The range of movement detection supported and the power consumed is dependent on the profile being used. See SetLocatorProfile() for more information.

Attempting to add an observer that is already present has no effect. That is, duplicate observers are not added but the method does not leave.

Movement observers can be removed using RemoveMovementObserver().

Note: No security capabilities are required to add a movement observer or receive movement events.

The observer will not be added if the method leaves.

Parameters:

+ + +

[in] aObserver The observer to be added.

KErrNoMemory If there has been a memory allocation problem. OtherStatusCode When if some other issue prevents the observer being added

Parameters:

+ + +

[in] aObserver The observer to be added.

See also:: SetLocatorProfile(); +StartUpdatesL(); +NewL(); +RemoveMovementObserver()

+ +

+ + + + + + + + + + + + + + + + + + +

EXPORT_C TInt CLbsLocator::GetLocatorOption	(	TLbsLocatorOption	aOption,
		TInt &	aValue
	)			const

Retrieves the value for of an Option of the currently active profile.

Parameters:

+ + + +

`[in]`	aOption	The profile option to be modified from TLbsLocatorOption.
`[out]`	aValue	The current value of option.

Returns:: KErrNone When the specified current value was successfully retrieved.; +KErrNotSupported When parameter aOption is not supported by the current profile.

See also:: TLbsLocatorOption; +SetLocatorOption; +SetLocatorProfile()

+ +

+ + + + + + + + +

EXPORT_C TUid CLbsLocator::LocatorProfile ( ) const

Return the ID of the profile in use.

If the application has not selected a profile, the "Default" profile is used. In this situation LocatorProfile() will return KLbsProfileIdDefault.

Returns:: The UID of the profile currently in use.

See also:: SetLocatorProfile()

+ +

+ + + + + + + + + +

EXPORT_C CLbsLocator * CLbsLocator::NewL ( MLbsLocationObserver & aObserver ) [static]

Creates a new instance of the CLbsLocator interface class.

After the instance of the interface has been created, the application should select the desired profile using SetLocatorProfile(). To begin receiving location and/or movement information, the application must call StartUpdatesL(). The frequency and accuracy of these updates depend on the profile selected.

Additional observers can be added by the methods AddLocationObserverL() or AddMovementObserverL().

Note: The application must have the Location capability to call this version of NewL(). Otherwise, the method will leave with the error KErrPermissionDenied.

Parameters:

+ + +

[in] aObserver The observer will receive location updates.

Returns:: A pointer to a new instance of the CLbsLocator interface class. The calling application becomes the owner of the returned object and is responsible its disposal.

Location

See also:: NewL(); +SetLocatorProfile(); +StartUpdatesL(); +StopUpdates(); +AddLocationObserverL(); +RemoveLocationObserver()

+ +

+ + + + + + + + +

EXPORT_C CLbsLocator * CLbsLocator::NewL ( ) [static]

Creates a new instance of the CLbsLocator interface class.

After the instance of the interface has been created using this method, the application should select the desired profile using SetLocatorProfile() and add one or more observers. To begin receiving location and/or movement information, the application must call StartUpdatesL(). The frequency and accuracy of these updates depend on the profile selected.

Observers can be added by the methods AddLocationObserverL() or AddMovementObserverL().

Note: No platform capabilities are required to create an instance of the interface using this NewL() overload. However, the application must have the Location capability if it intends to received location updates. Platform security capabilities are checked when AddLocationObserverL() is called. No capabilities are required to receive movement events using AddMovementObserverL().

Returns:: A pointer to a new instance of the CLbsLocator interface class. The calling application becomes the owner of the returned class and is responsible its disposal.

See also:: NewL(MLbsLocationObserver& aObserver); +SetLocatorProfile(); +AddLocationObserverL(); +AddMovementObserverL(); +StartUpdatesL(); +StopUpdates()

+ +

+ + + + + + + + + +

EXPORT_C TInt CLbsLocator::RemoveLocationObserver ( MLbsLocationObserver & aObserver )

Removes a Location Observer. The specified observer will no longer receive location updates.

It is possible to remove any of the current observers - including that supplied via NewL(MLbsLocationObserver& aObserver) overload.

Removing all observes without calling StopUpdates() may continue to consume resources and is not recommended.

Observers may be removed whilst the application is currently processing an update. For example, from within one observer's MLbsLocationObserver::HandleLocationUpdate() method. In this situation, the removed observer will not receive the current update (if it has has still to be delivered to it).

Parameters:

+ + +

[in] aObserver The observer to be removed.

Returns:: KErrNone When the specified observer has been removed.; +KErrNotFound When aObserver could not be found in the current list of location observers

See also:: NewL(MLbsLocationObserver& aObserver); +AddLocationObserverL(); +StopUpdates()

+ +

+ + + + + + + + + +

EXPORT_C TInt CLbsLocator::RemoveMovementObserver ( MLbsMovementObserver & aObserver )

Removes a Movement Observer. The specified observer will no longer receive Movement updates.

Removing all observes without calling StopUpdates() may continue to consume resources and is not recommended.

Observers may be removed whilst the application is currently processing an update. For example, from within one observer's MLbsMovementObserver::HandleMovementUpdate() method. In this situation, the removed observer will not receive the current update (if it has has still to be delivered to it).

Parameters:

+ + +

[in] aObserver The observer to be removed.

Returns:: KErrNone When the specified observer has been removed.; +KErrNotFound When aObserver could not be found in the current list of Movement observers

See also:: AddMovementObserverL(); +StopUpdates()

+ +

+ + + + + + + + + + + + + + + + + + +

EXPORT_C TInt CLbsLocator::SetLocatorOption	(	TLbsLocatorOption	aOption,
		TInt	aValue
	)

Modifies the behaviour of the currently active profile.

When an application changes the active profile using SetLocatorProfile()any previously modified option is lost. Applications must re-specify its desired options each time it changes profiles.

Changing a profile option has effect immediately.

Parameter aOption can be one of the following

ELocatorStatusTimer
- Parameter aValue is the timer period in seconds.
  +
  +
- The status timer indicates how long the subsystem should wait before informing the application that it has not been able to obtain a position of the target accuracy for the current profile. The method MLbsLocationObserver::HandleLocationStatus() is called after that period.
  +
  + Note: The status timer does NOT indicate how long the subsystem should try and get accurate positions. It only controls when the application is informed about the accuracy or position loss.
  +
  + The location subsystem will continue to try and obtain accurate positions until the application calls StopUpdates().
  +
  +
- A value of -1 is the default and indicates that profile specific logic should be used.
  +
  +
- A value of 0 can be used by the application when it wants to know if a cached position for the current location is NOT available.
  +
  + When a cached position is available, it is always the first location sent to the application after it calls StartUpdatesL(). When there is no cache position available the subsystem will (normally) start to calculate a new position start away.
  +
  + Setting the Status Timer to 0 gives the application an opportunity to prevent a new position being calculated when there is no cached position. In this situation, the status message KPositionNotAvailable is sent to the application after it calls StartUpdatesL(). If the application does not want a new location to be calculated it should call StopUpdates() during the status callback. If updates are not stopped at this stage then a new position will be calculated.
  +
  + After the cached position or the initial status message has been sent to the application, the default value of the status timer is then used.
  +
  + Note: Although this mechanism allows an application to query the cached position it is not intended for "listening" for location updates. Applications should use one of the alternative intefaces if this is required.
+

For more information on target accuracies and supported options for each profile see SetLocatorProfile().

Parameters:

+ + + +

`[in]`	aOption	The profile option to be modified from TLbsLocatorOption.
`[in]`	aValue	The new value of option.

Returns:: KErrNone When the specified option and value were accepted.; +KErrNotSupported When parameter aOption is not supported by the current profile.; +KErrArgument When the parameter aValue is not with the allowed range for aOption.

See also:: TLbsLocatorOption; +MLbsLocationObserver::HandleLocationStatus(); +SetLocatorProfile(); +GetLocatorOption()

+ +

+ + + + + + + + + +

EXPORT_C TInt CLbsLocator::SetLocatorProfile ( TUid aProfileId )

Specify the active profile to use for location and status updates.

The profile should initially be selected before StartUpdatesL() is called but can be changed at any time. Selecting a profile automatically affects subsequent updates. There is no need to request that updates are stopped and/or re-started.

If no profile is selected by an application the "Default" profile is used (KLbsProfileIdDefault).

Available Profiles are:

KLbsProfileIdDefault
KLbsProfileIdAreaMonitor
KLbsProfileIdLazyTracker

The "Default" profile (KLbsProfileIdDefault) allows existing S60 location based applications to easily move to the CLbsLocator API.

The target accuracy of this profile is 20 meters or better.
Applications will initially receive a cached location if available.
The minimum time between location updates is 1 second.
No movement information is supported.

The "Area Monitor" profile (KLbsProfileIdAreaMonitor) is designed to allow applications to discover the town or which part of a city the device is currently situated. The profile is designed to be power efficient and is suitable for long running applications that only need to know when their approximate location changes.

The target accuracy of this profile is 3km.
Applications will initially receive a cached location if available.
Location updates are generated when the device moves between 100m and 3km.
Stationary and Movement detection are supported.
Movement updates indicate the device has moved more than 100m (but more typically 3km).

The "Lazy Tracker" profile (KLbsProfileIdLazyTracker) enables applications to record the movements of the device over an extended period of time. A key goal of this profile is to be more power efficient than the default profile. This profile will attempt to save power by various techniques including switching GPS off if the device has been stationary for an extended period. It will also attempt to use other positioning technologies such as WLAN (if available) when it is not possible to obtain a satellite based location. The profile is not normally suited to turn-by-turn navigation.

The target accuracy of this profile is 20m or better.
Applications will initially receive a cached location if available.
Location updates are generated when the device moves 30 meters or more.
Stationary, Movement and Walking detection are supported.

For all profiles, if position of the target accuracy cannot be obtained within the time out period, the location observer will receive an error notification of KErrTimedOut. See SetLocatorOption().

Parameters:

+ + +

[in] aProfileId The UID of the profiles will receive location and status updates.

Returns:: KErrNone When the specified profile was successfully selected.; +KErrArgument When parameter aProfileId contains an invalid profile ID.; +KErrNotSupported When parameter aProfileId contains a profile that is not currently available.

See also:: StartUpdatesL(); +StopUpdates(); +LocatorProfile(); +SetLocatorOption()

+ +

+ + + + + + + + +

EXPORT_C void CLbsLocator::StartUpdatesL ( )

Requests the location related updates are sent to the observers.

After the instance of the interface has been created, the application should select the desired profile using SetLocatorProfile() and ensure there is at least one observer. To begin receiving location information, the application must call StartUpdatesL().

After calling StartUpdatesL(), the observers will receive a cached location and current movement status if available. The frequency and accuracy of subsequent updates depend on the active profile. See SetLocatorProfile() for more information.

The StopUpdates() method should be used when an application no longer wishes to receive any new location, movement or status updates.

Calling StartUpdatesL() when there are no specified observers will not result in an error but will consume system resources and may drain additional battery power.

NewL()

See also:: SetLocatorProfile(); +StopUpdates(); +AddLocationObserverL(); +RemoveLocationObserver()

+ +

+ + + + + + + + +

EXPORT_C void CLbsLocator::StopUpdates ( )

Requests that all location and status updates are stopped.

The StopUpdates() method is used when an application no longer wishes to receive new location, movement or status updates. It can be used to temporarily or permanently halt updates. It is recommended (but not obligatory) to call StopUpdates() before the destructor is called.

It is legal and often convenient to call StopUdatesL() during an update callback. For example, within the application's HandleLocationUpdate() method. This pattern can be used when the application only wants to find the current location and has received an update of satisfactory accuracy.

When there are multiple observers and the application calls StopUpdates() from within an observer's callback, the current update will continue to be delivered to any remaining observers. That is, StopUpdates() prevents subsequent (i.e. new) updates being generated.

To re-start updates the StartUpdatesL() method must be used. That re-activates the profile from the beginning. In particular, a cached position will initially be sent to the application.

See also:: StartUpdatesL(); +RemoveLocationObserver(); +~CLbsLocator()

+ +

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

Z:/lbslocator/inc/lbslocator.h
Z:/lbslocator/src/lbslocator.cpp

MLbsLocationObserver Member List

This is the complete list of members for MLbsLocationObserver, including all inherited members. + + + +

HandleLocationStatus(TInt aStatus)	MLbsLocationObserver	`[virtual]`
HandleLocationUpdate(const TLbsLocation &aLocation)=0	MLbsLocationObserver	`[pure virtual]`
Version() const	MLbsLocationObserver	`[virtual]`

MLbsLocationObserver Class Reference

#include <lbslocationobserver.h>

+ +

+ + + + + +

Public Member Functions
virtual void	HandleLocationUpdate (const TLbsLocation &aLocation)=0
virtual void	HandleLocationStatus (TInt aStatus)
virtual TVersion	Version () const

Detailed Description

MLbsLocationObserver - Provides callback methods for CLbsLocator to send location updates and status reports to the application.

Location updates provide Latitude and Longitude information and may contain Altitude, Course and Speed data.

The frequency and accuracy of these updates and the power consumed is dependent on the performance profile being used.

Applications need only to implement the HandleLocationUpdate() method of this class. If status information is important then HandleLocationStatus() should also be implemented.

See also:: CLbsLocator; +TLbsLocation

Member Function Documentation

+ +

+ + + + + + + + + +

void MLbsLocationObserver::HandleLocationStatus ( TInt aStatus ) [virtual]

Applications must implement this method to receive location status updates.

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

Status updates are typically generated when it has not been possible to obtain either a sufficiently accurate position for the active profile or indeed any position. Such events are normal and are often transient. They do not indicate an error with the hardware or system.

In these types of situations, the parameter aStatus will contain a positive value. The system will continue to try and obtain a more accurate position and there is generally no need for the application to change profiles, stop or restart updates.

When positions of target accuracy has been achieved, HandleLocationStatus() will be called with the status code of KErrNone.

It depends on the active profile when status updates about the accuracy or availability of positions are sent to the application . Applications can change this timer period by calling CLbsLocator::SetLocatorOption() with the options ELocatorStatusTimer.

If HandleLocationStatus() 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.

Typical values of parameter aStatus include:

KPositionQualityLoss: Indicates that although it is still possible to obtain a position for the current location, its accuracy does not meet that expected for the active profile. For example, in the Lazy Tracker profile this will occurr when it has not been possible to obatin a GPS position but a cell based location is available.
+
+

KPositionNotAvailable: This status code informs that application that no position information can be obatined for the current location.
+
+

KErrNone: Indicates that a previously reported problem related to the position availability or accuracy has passed. It is has now been possible to obtain positions that meets the target of the active profile.
+
+

When a Symbian OS (negative) error code is passed, this indicates there is a problem with the system and/or the hardware. This will normally prevent any position information being returned.

Parameters:

+ + +

[in] aStatus A positive value indicates there is a loss of accuracy or no position is currently available. This is generally a transient situation. A negative value means an error has occurred that will normally prevent any position information being returned. KErrNone is returned when normal service has been restored.

See also:: HandleLocationUpdate; +CLbsLocator::SetLocatorOption(); +CLbsLocator::StartUpdatesL(); +CLbsLocator::StopUpdates(); +CLbsLocator::SetLocatorProfile()

+ +

+ + + + + + + + + +

void MLbsLocationObserver::HandleLocationUpdate ( const TLbsLocation & aLocation ) [pure virtual]

Applications must implement this method to receive location updates.

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

After calling StartUpdatesL(), the first update an application will receive is a cached location (if available). The application should check the accuracy of this initial update to determine how useful it is. The accuracy of cached positions is likely to vary from a few kilometers up to the country level. That is, an application may receive an initial position only based on the country they are in.

Only after delivering any initial cached position will the system attempt obtain the current location. Application will normally be sent location updates with improving accuracy until the target accuracy for the active profile is achieved.

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 HandleLocationUpdate() callback. Stopping updates while the initial cached position is being deliverd, prevents the search for the current positioning being initiated. This is a useful technique to reduce cost and power consumption.

The point at which subsequent updates sent to the application depends on the active profile. Applications will receive updates when the device has moved a designated distance and/or after a time period.

Applications may received notification about the loss of accuracy and unavailability of position information by implementing the HandleLocationStatus() method. This method is also used to pass error information to the application.

Parameters:

+ + +

[in] aLocation Initially may contain a cached location if available, subsequent updates hold the current location of the device.
+ The accuracy of the location should be checked to determine how useful it is to the application.

See also:: TLbsLocation; +HandleLocationStatus; +CLbsLocator::StartUpdatesL(); +CLbsLocator::StopUpdates(); +CLbsLocator::SetLocatorProfile(); +CLbsLocator::SetLocatorOption()

+ +

+ + + + + + + + +

TVersion MLbsLocationObserver::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:

Z:/lbslocator/inc/lbslocationobserver.h
Z:/lbslocator/src/lbslocationobserver.cpp

MLbsMovementObserver Member List

This is the complete list of members for MLbsMovementObserver, including all inherited members. + + + +

HandleMovementStatus(TInt aStatus)	MLbsMovementObserver	`[virtual]`
HandleMovementUpdate(const TLbsMovementEvent &aEvent)=0	MLbsMovementObserver	`[pure virtual]`
Version() const	MLbsMovementObserver	`[virtual]`

MLbsMovementObserver Class Reference

#include <lbsmovementobserver.h>

+ +

+ + + + + +

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:

Z:/lbslocator/inc/lbsmovementobserver.h
Z:/lbslocator/src/lbsmovementobserver.cpp

TLbsLocation Member List

This is the complete list of members for TLbsLocation, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Accuracy() const	TLbsLocation
Altitude() const	TLbsLocation
AltitudeAccuracy() const	TLbsLocation
Course() const	TLbsLocation
CourseAccuracy() const	TLbsLocation
GetBearingTo(const TLbsLocation &aOtherLocation, TReal32 &aBearing) const	TLbsLocation
GetDistance(const TLbsLocation &aOtherLocation, TReal32 &aDistance) const	TLbsLocation
GetMeanSpeed(const TLbsLocation &aOtherLocation, TReal32 &aMeanSpeed) const	TLbsLocation
iClassSize	TLbsLocatorClassTypeBase	`[protected]`
iClassType	TLbsLocatorClassTypeBase	`[protected]`
IsAltitudeValid() const	TLbsLocation
IsCourseValid() const	TLbsLocation
IsLatLongValid() const	TLbsLocation
IsSpeedValid() const	TLbsLocation
Latitude() const	TLbsLocation
LocatorClassSize() const	TLbsLocatorClassTypeBase
LocatorClassType() const	TLbsLocatorClassTypeBase
Longitude() const	TLbsLocation
Move(TReal32 aBearing, TReal32 aDistance)	TLbsLocation
SetAltitude(TReal32 aAltitude, TReal32 aAccuracy)	TLbsLocation
SetCourse(TReal32 aCourse, TReal32 aAccuracy)	TLbsLocation
SetLocation(TReal64 aLatitude, TReal64 aLongitude, TReal32 aAccuracy)	TLbsLocation
SetSpeed(TReal32 aSpeed, TReal32 aAccuracy)	TLbsLocation
SetSystemTimeStamp(TTime aTimeStamp)	TLbsLocation
Speed() const	TLbsLocation
SpeedAccuracy() const	TLbsLocation
SystemTimeStamp() const	TLbsLocation
TLbsLocation() (defined in TLbsLocation)	TLbsLocation
TLbsLocatorClassTypeBase() (defined in TLbsLocatorClassTypeBase)	TLbsLocatorClassTypeBase	`[protected]`

TLbsLocation Class Reference

#include <lbslocation.h>

+Inheritance diagram for TLbsLocation:

+ + + +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions
IMPORT_C TBool	IsLatLongValid () const
IMPORT_C TReal64	Latitude () const
IMPORT_C TReal64	Longitude () const
IMPORT_C TReal32	Accuracy () const
IMPORT_C TBool	IsAltitudeValid () const
IMPORT_C TReal32	Altitude () const
IMPORT_C TReal32	AltitudeAccuracy () const
IMPORT_C TBool	IsSpeedValid () const
IMPORT_C TReal32	Speed () const
IMPORT_C TReal32	SpeedAccuracy () const
IMPORT_C TBool	IsCourseValid () const
IMPORT_C TReal32	Course () const
IMPORT_C TReal32	CourseAccuracy () const
IMPORT_C TInt	GetMeanSpeed (const TLbsLocation &aOtherLocation, TReal32 &aMeanSpeed) const
IMPORT_C TInt	GetDistance (const TLbsLocation &aOtherLocation, TReal32 &aDistance) const
IMPORT_C TInt	GetBearingTo (const TLbsLocation &aOtherLocation, TReal32 &aBearing) const
IMPORT_C TInt	Move (TReal32 aBearing, TReal32 aDistance)
IMPORT_C TTime	SystemTimeStamp () const
IMPORT_C TInt	SetLocation (TReal64 aLatitude, TReal64 aLongitude, TReal32 aAccuracy)
IMPORT_C TInt	SetAltitude (TReal32 aAltitude, TReal32 aAccuracy)
IMPORT_C TInt	SetSpeed (TReal32 aSpeed, TReal32 aAccuracy)
IMPORT_C TInt	SetCourse (TReal32 aCourse, TReal32 aAccuracy)
IMPORT_C TInt	SetSystemTimeStamp (TTime aTimeStamp)

Detailed Description

TLbsLocation - Contains a position and its accuracy. May contain altitude, speed and course. See .cpp file for extended comments.

Member Function Documentation

+ +

+ + + + + + + + +

EXPORT_C TReal32 TLbsLocation::Accuracy ( ) const

Retrieves the horizontal (circular) accuracy of the latitude and longitude in meters.

If the accuracy has not been assigned the method returns zero.

Applications should use IsLatLongValid() to determine if there is a valid accuracy.

Returns:: The circular accuracy in meters of the latitude and longitude; +Zero if the location accuracy has not been assigned.

See also:: IsLatLongValid(); +Latitude(); +Longitude(); +SetLocation()

+ +

+ + + + + + + + +

EXPORT_C TReal32 TLbsLocation::Altitude ( ) const

Retrieves the altitude in meters for the location.

If the altitude is not available the method returns zero. Availability of altitude information is dependent on the underlying positioning technology and will not always be present.

Applications should use IsAltitudeValid() to determine if there is a valid altitude.

Returns:: The altitude in meters when the location contains a valid altitude.; +Zero when altitude information is unavailable.

See also:: IsAltitudeValid(); +AltitudeAccuracy(); +SetAltitude()

+ +

+ + + + + + + + +

EXPORT_C TReal32 TLbsLocation::AltitudeAccuracy ( ) const

Retrieves the vertical accuracy of the location.

If the altitude is not available the method returns zero. Availability of altitude information is dependent on the underlying positioning technology and will not always be present.

Applications should use IsAltitudeValid() to determine if there is a valid altitude.

Returns:: The vertical accuracy in meters when the location contains a valid altitide.; +Zero when altitude information is unavailable.

See also:: IsAltitudeValid(); +Altitude(); +SetAltitude()

+ +

+ + + + + + + + +

EXPORT_C TReal32 TLbsLocation::Course ( ) const

Retrieves the course in degrees counting clockwise relative to true north.

If the course is not available, the method returns zero.

Availability of course information is dependent on the underlying positioning technology and will not always be present. Even satellite based technologies may not provide course information in certain circumstances.

Applications should use IsCourseValid() to determine if there is a valid course.

When there is a valid course, the range of values will be from [0 to 360). That is: values can be up to (but will not include) 360. A value of 0 indicates the device is heading north.

Returns:: The course in degrees from the range [0 to 360) when the location contains a valid course.; +Zero when course information is unavailable.

See also:: IsCourseValid(); +CourseAccuracy(); +SetCourse()

+ +

+ + + + + + + + +

EXPORT_C TReal32 TLbsLocation::CourseAccuracy ( ) const

Retrieves the accuracy of the course information in degrees.

If the course is not available the method returns zero.

Availability of course information is dependent on the underlying positioning technology and will not always be present.

Applications should use IsCourseValid() to determine if there is a valid course.

When course information is available, the accuracy indicates the size of the error band. The actual course may be vary from the reported course but the difference should be less than or equal to the course accuracy.

Returns:: The accuracy of the course in degrees when the location contains a valid course.; +Zero when course information is unavailable.

See also:: IsCourseValid(); +Course(); +SetCourse()

+ +

+ + + + + + + + + + + + + + + + + + +

EXPORT_C TInt TLbsLocation::GetBearingTo	(	const TLbsLocation &	aOtherLocation,
		TReal32 &	aBearing
	)			const

Calculate the bearing in degrees from this location to the supplied location.

Parameters:

+ + + +

`[in]`	aOtherLocation	Target location.
`[out]`	aBearing	Upon successful completion, this is set to the bearing from this location to aOtherLocation. Value is in degrees counting clockwise relative to true north.

Returns:: KErrNone When the bearing has been successfully calculated.; +KErrArgument If any of the Latitudes or Longitudes have not been assigned.; +KErrPositionIncalculable if this location is at a pole or if the two locations are the same or antipodal.; +A Symbian OS error code if some other problem prevents the calculation.

+ +

+ + + + + + + + + + + + + + + + + + +

EXPORT_C TInt TLbsLocation::GetDistance	(	const TLbsLocation &	aOtherLocation,
		TReal32 &	aDistance
	)			const

Calculate the distance between this location and the supplied location.

Parameters:

+ + + +

`[in]`	aOtherLocation	A point different from this Location.
`[out]`	aDistance	Upon successful completion, this is set to the distance between this location and aOtherLocation, in meters.

Returns:: KErrNone When the distance has been successfully calculated.; +KErrArgument If any of the Latitudes or Longitudes have not been assigned.; +A Symbian OS error code if some other problem prevents the calculation.

+ +

+ + + + + + + + + + + + + + + + + + +

EXPORT_C TInt TLbsLocation::GetMeanSpeed	(	const TLbsLocation &	aOtherLocation,
		TReal32 &	aMeanSpeed
	)			const

This method calculates the mean horizontal speed in meters per second between this location and the supplied aOtherLocation. The speed is calculated based on the latitude and longitude of each of the locations and their system timestamps.

Parameters:

+ + + +

`[in]`	aOtherLocation	A point different from this Location.
`[out]`	aMeanSpeed	Upon successful completion, this is set to the speed indicated by being at this position at its recorded time, and at aOtherLocation at its recorded time. Always positive, in meters per second.

Returns:: KErrNone When the mean speed has been successfully calculated.; +KErrArgument If any of the Latitudes, Longitudes, or System Timestamps have not been assigned.; +KErrArgument If the System Timestamp for this or aOtherLocation are the same.; +A Symbian OS error code if some other problem prevents the calculation.

+ +

+ + + + + + + + +

EXPORT_C TBool TLbsLocation::IsAltitudeValid ( ) const

Determines if an altitude has been assigned.

Availability of altitude information is dependent on the underlying positioning technology and will not always be present.

Returns:: ETrue When a valid altitude is available for the location.; +EFalse When altitude information is unavailable.

See also:: Altitude(); +AltitudeAccuracy(); +SetAltitude()

+ +

+ + + + + + + + +

EXPORT_C TBool TLbsLocation::IsCourseValid ( ) const

Determines if a valid course is available.

Returns:: ETrue When a valid course is available for the location.; +EFalse When course information is unavailable.

See also:: Course(); +CourseAccuracy(); +SetCourse()

+ +

+ + + + + + + + +

EXPORT_C TBool TLbsLocation::IsLatLongValid ( ) const

Determines if a latitude and longitude and (horizontal) accuracy has been assigned.

Positions returned by the location subsystem will have a valid latitude, longitude and accuracy.

When applications create their own instances of the TLbsLocation class this method will return EFalse until a latitude and longitude has been assigned.

Returns:: ETrue When a valid latitude and longitude are available for the location.; +EFalse When no valid latitude and longitude are available for the location.

See also:: Latitude(); +Longitude(); +Accuracy(); +SetLocation()

+ +

+ + + + + + + + +

EXPORT_C TBool TLbsLocation::IsSpeedValid ( ) const

Determines if a valid speed is available.

Availability of speed information is dependent on the underlying positioning technology and will not always be present. Even satellite based technologies may not provide speed information in certain circumstances.

Returns:: ETrue When a valid speed is available for the location.; +EFalse When speed information is unavailable.

See also:: Speed(); +SpeedAccuracy(); +SetSpeed()

+ +

+ + + + + + + + +

EXPORT_C TReal64 TLbsLocation::Latitude ( ) const

Retrieves the latitude of the location. Coordinates are referenced to WGS84 datum.

If the latitude has not been assigned the method returns zero.

Applications should use IsLatLongValid() to determine if there is a valid latitude.

Returns:: The latitude of the location in degrees from the range -90 to +90 when the location contains a valid latitude.; +Zero if the latitude has not been assigned.

See also:: IsLatLongValid(); +Longitude(); +Accuracy(); +SetLocation()

+ +

+ + + + + + + + +

EXPORT_C TReal64 TLbsLocation::Longitude ( ) const

Retrieves the longitude of the location. Coordinates are referenced to WGS84 datum.

If the longitude has not been assigned the method returns zero.

Applications should use IsLatLongValid() to determine if there is a valid longitude.

Returns:: The longitude of the location in degrees from the range 0 up to (but not including) 360 when the location contains a valid longitude.; +Zero if the longitude has not been assigned.

See also:: IsLatLongValid(); +Latitude(); +Accuracy(); +SetLocation()

+ +

+ + + + + + + + + + + + + + + + + + +

EXPORT_C TInt TLbsLocation::Move	(	TReal32	aBearing,
		TReal32	aDistance
	)

This method moves this location aDistance in the direction specified by aBearing

Parameters:

+ + + +

`[in]`	aBearing	The direction to move this location. Value is in degrees counting clockwise relative to true north.
`[in]`	aDistance	The distance to move this Location. Value is in meters.

Returns:: KErrNone When the move has been successfully completed.; +KErrArgument If the Latitude or Longitude for this location have not been assigned.; +KErrPositionIncalculable if this location is at a pole.; +A Symbian OS error code if some other problem prevents the calculation.

+ +

+ + + + + + + + + + + + + + + + + + +

EXPORT_C TInt TLbsLocation::SetAltitude	(	TReal32	aAltitude,
		TReal32	aAccuracy
	)

Sets the altitude information for the location.

After the altitude has been successfully assigned, the method IsAltitudeValid will return ETrue.

Parameters:

+ + + +

`[in]`	aAltitude	The altitude of the location in meters.
`[in]`	aAccuracy	The accuracy of the course in degrees. Value cannot be negative

Returns:: KErrNone If parameter aAccuracy is in range and have been set successfully.; +KErrArgument If parameter aAccuracy is negative.

See also:: IsAltitudeValid(); +Altitude(); +AltitudeAccuracy()

+ +

+ + + + + + + + + + + + + + + + + + +

EXPORT_C TInt TLbsLocation::SetCourse	(	TReal32	aCourse,
		TReal32	aAccuracy
	)

Sets the course information for the location.

If the course paramater is outside the range [0,360) it will be automatically adjusted to fall within the valid range. For example, attempting to set a course 361 degrees will be converted to 1 degree.

After the course has been successfully assigned, the method IsCourseValid() will return ETrue.

Parameters:

+ + + +

`[in]`	aCourse	Degrees counting clockwise relative to true north. Normal range is 0 up to (but not including) 360.
`[in]`	aAccuracy	The accuracy of the course in degrees. Value cannot be negative

Returns:: KErrNone If parameter aAccuracy is in range and have been set successfully.; +KErrArgument If parameter aAccuracy is negative.

See also:: IsCourseValid(); +Course(); +CourseAccuracy()

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +

EXPORT_C TInt TLbsLocation::SetLocation	(	TReal64	aLatitude,
		TReal64	aLongitude,
		TReal32	aAccuracy
	)

Sets the position information for the location.

If the latitude and longitude paramaters are outside the range [-90,+90], [0,360) the position will be automatically adjusted to fall within the valid range. For example, attempting to set a position of latitude 91, longitude 0 will be converted into 89, 180, respectively.

After these parameters have been successfully assigned, the method IsLatLongValid() will return ETrue.

Parameters:

+ + + + +

`[in]`	aLatitude	The latitude of the location in degrees. Normal range is 0 up to (but not including) 360 degrees.
`[in]`	aLongitude	The longitude of the location in degrees. Normal range is -90 to +90 (inclusive).
`[in]`	aAccuracy	The accuracy of the course in degrees. Value cannot be negative

Returns:: KErrNone If parameter aAccuracy is in range and have been set successfully.; +KErrArgument If parameter aAccuracy is negative.

See also:: IsLatLongValid(); +Latitude(); +Longitude(); +Accuracy()

+ +

+ + + + + + + + + + + + + + + + + + +

EXPORT_C TInt TLbsLocation::SetSpeed	(	TReal32	aSpeed,
		TReal32	aAccuracy
	)

Sets the speed information for the location.

After the speed has been successfully assigned, the method IsSpeedValid() will return ETrue.

Parameters:

+ + + +

`[in]`	aSpeed	The speed that is related to the location in meters per second. Value cannot be negative.
`[in]`	aAccuracy	The accuracy of the speed in meters per second. Value cannot be negative.

Returns:: KErrNone If all parameters are in range and have been set successfully.; +KErrArgument If either parameter is negative.

See also:: IsSpeedValid(); +Speed(); +SpeedAccuracy()

+ +

+ + + + + + + + + +

EXPORT_C TInt TLbsLocation::SetSystemTimeStamp ( TTime aTimeStamp )

Sets the system time stamp for the location information.

This is the time when the location information entered the system.

The parameter aTimeStamp must contain a valid time and cannot be "zero".

Parameters:

+ + +

[in] aTimeStamp The system time that is related to the location information.

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 TReal32 TLbsLocation::Speed ( ) const

Retrieves the speed in meters per second.

If the speed is not available the method returns zero.

Applications should use IsSpeedValid() to determine if there is a valid speed.

Returns:: The speed in meters per second when the location contains a valid speed.; +Zero when speed is unavailable.

See also:: IsSpeedValid(); +SpeedAccuracy(); +SetSpeed()

+ +

+ + + + + + + + +

EXPORT_C TReal32 TLbsLocation::SpeedAccuracy ( ) const

Retrieves the accuracy of the speed information in meters per second.

If the speed is not available the method returns zero.

Availability of speed information is dependent on the underlying positioning technology and will not always be present.

When speed information is available, the accuracy indicates the size of the error band. The actual speed may be above or below the reported speed but the difference should be less than or equal to the speed accuracy.

Applications should use IsSpeedValid() to determine if there is a valid speed.

Returns:: The accuracy speed in meters per second when the location contains a valid speed.; +Zero when the speed is unavailable.

See also:: IsSpeedValid(); +Speed(); +SetSpeed()

+ +

+ + + + + + + + +

EXPORT_C TTime TLbsLocation::SystemTimeStamp ( ) const

Retrieves the time on the device when the location entered the system.

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

This timestamp is assigned by the local device and reflects when the location information injected. In particular, this timestamp does not provide technology specific information such as GPS time.

Returns:: The time when the location entered the system.; +Zero If no valid course is available.

See also:: SetSystemTimeStamp()

+ +

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

Z:/lbslocator/inc/lbslocation.h
Z:/lbslocator/src/lbslocation.cpp

TLbsLocatorClassTypeBase Member List

This is the complete list of members for TLbsLocatorClassTypeBase, including all inherited members. + + + + + +

iClassSize	TLbsLocatorClassTypeBase	`[protected]`
iClassType	TLbsLocatorClassTypeBase	`[protected]`
LocatorClassSize() const	TLbsLocatorClassTypeBase
LocatorClassType() const	TLbsLocatorClassTypeBase
TLbsLocatorClassTypeBase() (defined in TLbsLocatorClassTypeBase)	TLbsLocatorClassTypeBase	`[protected]`

TLbsLocatorClassTypeBase Class Reference

#include <lbslocatorclasstypes.h>

+Inheritance diagram for TLbsLocatorClassTypeBase:

+ + + + +

+ +

+ + + + + + + +

Public Member Functions
IMPORT_C TUint32	LocatorClassType () const
IMPORT_C TUint	LocatorClassSize () const
Protected Attributes
TUint32	iClassType
TUint	iClassSize

Detailed Description

TLbsLocatorClassTypeBase - Base class for data generated by CLbsLocator.

Member Function Documentation

+ +

+ + + + + + + + +

EXPORT_C TUint TLbsLocatorClassTypeBase::LocatorClassSize ( ) const

Retrieves the size of the locator based class.

Returns:: The size of the TPositionClassTypeBase-derived class

+ +

+ + + + + + + + +

EXPORT_C TUint32 TLbsLocatorClassTypeBase::LocatorClassType ( ) const

Retrives a bit mask containing the type of the locator generated class.

Returns:: A bit mask containing the type of the TLbsLocatorClassTypeBase-derived class

+ +

Member Data Documentation

+ +

+ + + + +

TUint TLbsLocatorClassTypeBase::iClassSize [protected]

The size of the derived class

+ +

+ + + + +

TUint32 TLbsLocatorClassTypeBase::iClassType [protected]

The type of the derived class

+ +

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

Z:/lbslocator/inc/lbslocatorclasstypes.h
Z:/lbslocator/src/lbslocatorclasstypes.cpp

TLbsMovementEvent Member List

This is the complete list of members for TLbsMovementEvent, including all inherited members. + + + + + + + + + + + + + + + + +

EMovementEventLastBit enum value (defined in TLbsMovementEvent)	TLbsMovementEvent
EMovementEventMoving enum value (defined in TLbsMovementEvent)	TLbsMovementEvent
EMovementEventStationary enum value (defined in TLbsMovementEvent)	TLbsMovementEvent
EMovementEventUnknown enum value (defined in TLbsMovementEvent)	TLbsMovementEvent
EMovementEventWalking enum value (defined in TLbsMovementEvent)	TLbsMovementEvent
iClassSize	TLbsLocatorClassTypeBase	`[protected]`
iClassType	TLbsLocatorClassTypeBase	`[protected]`
LocatorClassSize() const	TLbsLocatorClassTypeBase
LocatorClassType() const	TLbsLocatorClassTypeBase
MovementEvent() const	TLbsMovementEvent
SetMovementEvent(TLbsMovementEventType aEvent)	TLbsMovementEvent
SetSystemTimeStamp(TTime aTimeStamp)	TLbsMovementEvent
SystemTimeStamp() const	TLbsMovementEvent
TLbsLocatorClassTypeBase() (defined in TLbsLocatorClassTypeBase)	TLbsLocatorClassTypeBase	`[protected]`
TLbsMovementEvent() (defined in TLbsMovementEvent)	TLbsMovementEvent
TLbsMovementEventType enum name	TLbsMovementEvent

TLbsMovementEvent Class Reference

#include <lbsmovementevent.h>

+Inheritance diagram for TLbsMovementEvent:

+ + + +

+ +

+ + + + + + + + +

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

+ +

+ + + + +

enum TLbsMovementEvent::TLbsMovementEventType

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:

Z:/lbslocator/inc/lbsmovementevent.h
Z:/lbslocator/src/lbsmovementevent.cpp

Class Index

C | M | T

+ +

MLbsMovementObserver

TLbsLocation

TLbsMovementEvent

CLbsLocator

MLbsLocationObserver

TLbsLocatorClassTypeBase

C | M | T

+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. + + diff -r a06e4186b3d5 -r dbf7d0760deb locationmgmt/locationcore/LbsClient/lbslocator/doc_pub/html/doxygen.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/locationmgmt/locationcore/LbsClient/lbslocator/doc_pub/html/doxygen.css Wed May 05 12:51:17 2010 +0100 @@ -0,0 +1,545 @@ +/* The standard CSS for doxygen */ + +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + text-align: center; + font-size: 150%; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #153788; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #1b77c5; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { + color: #3030f0; +} + +a.codeRef { + color: #3030f0; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} + +td.indexkey { + background-color: #e8eef2; + font-weight: bold; + border: 1px solid #CCCCCC; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #e8eef2; + border: 1px solid #CCCCCC; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #f0f0f0; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} + +th.dirtab { + background: #e8eef2; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #666; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #FAFAFA; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #ccc; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memTemplParams { + color: #606060; + white-space: nowrap; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} + +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.memitem { + padding: 0; + margin-bottom: 10px; +} + +.memname { + white-space: nowrap; + font-weight: bold; + margin-left: 6px; +} + +.memproto { + border-top: 1px solid #84b0c7; + border-left: 1px solid #84b0c7; + border-right: 1px solid #84b0c7; + padding: 0; + background-color: #d5e1e8; + font-weight: bold; + /* firefox specific markup */ + background-image: -moz-linear-gradient(rgba(228, 233, 245, 1.0) 0%, rgba(193, 205, 232, 1.0) 100%); + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 8px; + -moz-border-radius-topleft: 8px; + /* webkit specific markup */ + background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(rgba(228, 233, 245, 1.0)), to(rgba(193, 205, 232, 1.0))); + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 8px; + -webkit-border-top-left-radius: 8px; + +} + +.memdoc { + border-bottom: 1px solid #84b0c7; + border-left: 1px solid #84b0c7; + border-right: 1px solid #84b0c7; + padding: 2px 5px; + background-color: #eef3f5; + border-top-width: 0; + /* firefox specific markup */ + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0.5em; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +address { + font-style: normal; + color: #333; +} + +table.doxtable { + border-collapse:collapse; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #153788; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #254798; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; +} + diff -r a06e4186b3d5 -r dbf7d0760deb locationmgmt/locationcore/LbsClient/lbslocator/doc_pub/html/doxygen.png Binary file locationmgmt/locationcore/LbsClient/lbslocator/doc_pub/html/doxygen.png has changed diff -r a06e4186b3d5 -r dbf7d0760deb locationmgmt/locationcore/LbsClient/lbslocator/doc_pub/html/files.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/locationmgmt/locationcore/LbsClient/lbslocator/doc_pub/html/files.html Wed May 05 12:51:17 2010 +0100 @@ -0,0 +1,47 @@ + + + + +LbsLocator: File Index + + + + + + +

File List

Here is a list of all documented files with brief descriptions: + + + + + + + + + + + + +

Z:/lbslocator/inc/lbslocation.h [code]
Z:/lbslocator/inc/lbslocationobserver.h [code]
Z:/lbslocator/inc/lbslocator.h [code]
Z:/lbslocator/inc/lbslocatorclasstypes.h [code]
Z:/lbslocator/inc/lbsmovementevent.h [code]
Z:/lbslocator/inc/lbsmovementobserver.h [code]
Z:/lbslocator/src/lbslocation.cpp
Z:/lbslocator/src/lbslocationobserver.cpp
Z:/lbslocator/src/lbslocator.cpp
Z:/lbslocator/src/lbslocatorclasstypes.cpp
Z:/lbslocator/src/lbsmovementevent.cpp
Z:/lbslocator/src/lbsmovementobserver.cpp

+Here is a list of all documented class members with links to the class documentation for each member: + +

- a -

Accuracy() +: TLbsLocation +
AddLocationObserverL() +: CLbsLocator +
AddMovementObserverL() +: CLbsLocator +
Altitude() +: TLbsLocation +
AltitudeAccuracy() +: TLbsLocation +

+ + +

- c -

Course() +: TLbsLocation +
CourseAccuracy() +: TLbsLocation +

+ + +

- e -

ELocatorStatusTimer +: CLbsLocator +

+ + +

- g -

GetBearingTo() +: TLbsLocation +
GetDistance() +: TLbsLocation +
GetLocatorOption() +: CLbsLocator +
GetMeanSpeed() +: TLbsLocation +

+ + +

- h -

HandleLocationStatus() +: MLbsLocationObserver +
HandleLocationUpdate() +: MLbsLocationObserver +
HandleMovementStatus() +: MLbsMovementObserver +
HandleMovementUpdate() +: MLbsMovementObserver +

+ + +

- i -

iClassSize +: TLbsLocatorClassTypeBase +
iClassType +: TLbsLocatorClassTypeBase +
IsAltitudeValid() +: TLbsLocation +
IsCourseValid() +: TLbsLocation +
IsLatLongValid() +: TLbsLocation +
IsSpeedValid() +: TLbsLocation +

+ + +

- l -

Latitude() +: TLbsLocation +
LocatorClassSize() +: TLbsLocatorClassTypeBase +
LocatorClassType() +: TLbsLocatorClassTypeBase +
LocatorProfile() +: CLbsLocator +
Longitude() +: TLbsLocation +

+ + +

- m -

Move() +: TLbsLocation +
MovementEvent() +: TLbsMovementEvent +

+ + +

- n -

NewL() +: CLbsLocator +

+ + +

- r -

RemoveLocationObserver() +: CLbsLocator +
RemoveMovementObserver() +: CLbsLocator +

+ + +

- s -

SetAltitude() +: TLbsLocation +
SetCourse() +: TLbsLocation +
SetLocation() +: TLbsLocation +
SetLocatorOption() +: CLbsLocator +
SetLocatorProfile() +: CLbsLocator +
SetMovementEvent() +: TLbsMovementEvent +
SetSpeed() +: TLbsLocation +
SetSystemTimeStamp() +: TLbsLocation +, TLbsMovementEvent +
Speed() +: TLbsLocation +
SpeedAccuracy() +: TLbsLocation +
StartUpdatesL() +: CLbsLocator +
StopUpdates() +: CLbsLocator +
SystemTimeStamp() +: TLbsMovementEvent +, TLbsLocation +

+ + +

- t -

TLbsLocatorOption +: CLbsLocator +
TLbsMovementEventType +: TLbsMovementEvent +

+ + +

- v -

Version() +: MLbsLocationObserver +, MLbsMovementObserver +

+ + +

- ~ -

~CLbsLocator() +: CLbsLocator +

TLbsLocatorOption +: CLbsLocator +
TLbsMovementEventType +: TLbsMovementEvent +

ELocatorStatusTimer +: CLbsLocator +

+ + +

- a -

Accuracy() +: TLbsLocation +
AddLocationObserverL() +: CLbsLocator +
AddMovementObserverL() +: CLbsLocator +
Altitude() +: TLbsLocation +
AltitudeAccuracy() +: TLbsLocation +

+ + +

- c -

Course() +: TLbsLocation +
CourseAccuracy() +: TLbsLocation +

+ + +

- g -

GetBearingTo() +: TLbsLocation +
GetDistance() +: TLbsLocation +
GetLocatorOption() +: CLbsLocator +
GetMeanSpeed() +: TLbsLocation +

+ + +

- h -

HandleLocationStatus() +: MLbsLocationObserver +
HandleLocationUpdate() +: MLbsLocationObserver +
HandleMovementStatus() +: MLbsMovementObserver +
HandleMovementUpdate() +: MLbsMovementObserver +

+ + +

- i -

IsAltitudeValid() +: TLbsLocation +
IsCourseValid() +: TLbsLocation +
IsLatLongValid() +: TLbsLocation +
IsSpeedValid() +: TLbsLocation +

+ + +

- l -

Latitude() +: TLbsLocation +
LocatorClassSize() +: TLbsLocatorClassTypeBase +
LocatorClassType() +: TLbsLocatorClassTypeBase +
LocatorProfile() +: CLbsLocator +
Longitude() +: TLbsLocation +

+ + +

- m -

Move() +: TLbsLocation +
MovementEvent() +: TLbsMovementEvent +

+ + +

- n -

NewL() +: CLbsLocator +

+ + +

- r -

RemoveLocationObserver() +: CLbsLocator +
RemoveMovementObserver() +: CLbsLocator +

+ + +

- s -

SetAltitude() +: TLbsLocation +
SetCourse() +: TLbsLocation +
SetLocation() +: TLbsLocation +
SetLocatorOption() +: CLbsLocator +
SetLocatorProfile() +: CLbsLocator +
SetMovementEvent() +: TLbsMovementEvent +
SetSpeed() +: TLbsLocation +
SetSystemTimeStamp() +: TLbsLocation +, TLbsMovementEvent +
Speed() +: TLbsLocation +
SpeedAccuracy() +: TLbsLocation +
StartUpdatesL() +: CLbsLocator +
StopUpdates() +: CLbsLocator +
SystemTimeStamp() +: TLbsMovementEvent +, TLbsLocation +

+ + +

- v -

Version() +: MLbsLocationObserver +, MLbsMovementObserver +

+ + +

- ~ -

~CLbsLocator() +: CLbsLocator +

iClassSize +: TLbsLocatorClassTypeBase +
iClassType +: TLbsLocatorClassTypeBase +

+Here is a list of all documented file members with links to the documentation:

KLbsProfileIdAreaMonitor +: lbslocator.h +
KLbsProfileIdDefault +: lbslocator.h +
KLbsProfileIdLazyTracker +: lbslocator.h +

KLbsProfileIdAreaMonitor +: lbslocator.h +
KLbsProfileIdDefault +: lbslocator.h +
KLbsProfileIdLazyTracker +: lbslocator.h +

Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

CLbsLocator
MLbsLocationObserver
MLbsMovementObserver
TLbsLocatorClassTypeBase
- TLbsLocation
- TLbsMovementEvent
+

Z:/lbslocator/src/lbslocation.cpp File Reference

#include <lbslocation.h>
+ +

Detailed Description

Z:/lbslocator/inc/lbslocation.h File Reference

#include <e32base.h>
+#include <lbslocatorclasstypes.h>
+ +

+ + + +

Classes
class	TLbsLocation

Detailed Description

File List
File Members

Z:/lbslocator/inc/lbslocation.h

00001 /*
+00002 * Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
+00003 * All rights reserved.
+00004 * This component and the accompanying materials are made available
+00005 * under the terms of "Eclipse Public License v1.0"
+00006 * which accompanies this distribution, and is available
+00007 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
+00008 *
+00009 * Initial Contributors:
+00010 * Nokia Corporation - initial contribution.
+00011 *
+00012 * Contributors:
+00013 *
+00014 * Description:
+00015 *
+00016 */
+00017 
+00018 #ifndef __LBSLOCATION_H__
+00019 #define __LBSLOCATION_H__
+00020 
+00021 #include <e32base.h>
+00022 #include <lbslocatorclasstypes.h>
+00023 
+00035 class TLbsLocation : public TLbsLocatorClassTypeBase
+00036     {
+00037 public:
+00038     IMPORT_C TLbsLocation();
+00039 
+00040     /* Latitude, Longitude and Accuracy methods return 0 if not assigned */ 
+00041     IMPORT_C TBool   IsLatLongValid()  const;   
+00042     IMPORT_C TReal64 Latitude()        const;
+00043     IMPORT_C TReal64 Longitude()       const;
+00044     IMPORT_C TReal32 Accuracy()        const;
+00045     
+00046     /* Altitude and AltitudeAccuracy return 0 if not assigned */
+00047     IMPORT_C TBool   IsAltitudeValid() const;
+00048     IMPORT_C TReal32 Altitude()        const;    
+00049     IMPORT_C TReal32 AltitudeAccuracy()const;
+00050     
+00051     /*Speed and accuracy return 0 if not assigned */
+00052     IMPORT_C TBool   IsSpeedValid()    const;
+00053     IMPORT_C TReal32 Speed()           const;
+00054     IMPORT_C TReal32 SpeedAccuracy()   const;
+00055 
+00056     /* Course and accuracy returns 0 if not assigned */
+00057     IMPORT_C TBool   IsCourseValid()   const;
+00058     IMPORT_C TReal32 Course()          const;
+00059     IMPORT_C TReal32 CourseAccuracy()  const;
+00060    
+00061     /* Calculate the differences from this location to another location*/
+00062     IMPORT_C TInt    GetMeanSpeed(const TLbsLocation& aOtherLocation, TReal32& aMeanSpeed)const;
+00063     IMPORT_C TInt    GetDistance(const TLbsLocation&  aOtherLocation, TReal32& aDistance) const;
+00064     IMPORT_C TInt    GetBearingTo(const TLbsLocation& aOtherLocation, TReal32& aBearing)  const;    
+00065     
+00066     /* Translate this location along the bearing to the specified distance */
+00067     IMPORT_C TInt    Move(TReal32 aBearing, TReal32 aDistance);
+00068     
+00069     /* SystemTimeStamp returns a time of 0 if not assigned */
+00070     IMPORT_C TTime   SystemTimeStamp() const;        
+00071 
+00072     /* Methods to set values - see detailed comments for valid parameter ranges */
+00073     IMPORT_C TInt    SetLocation(TReal64 aLatitude, TReal64 aLongitude, TReal32 aAccuracy);
+00074     IMPORT_C TInt    SetAltitude(TReal32 aAltitude, TReal32 aAccuracy);
+00075     IMPORT_C TInt    SetSpeed(TReal32  aSpeed,  TReal32 aAccuracy);
+00076     IMPORT_C TInt    SetCourse(TReal32 aCourse, TReal32 aAccuracy);  
+00077     IMPORT_C TInt    SetSystemTimeStamp(TTime aTimeStamp);
+00078     
+00079 private:   
+00080     TBool   iIsLocationValid;
+00081     TReal64 iLatitude;
+00082     TReal64 iLongitude;
+00083     TReal32 iHorizontalAccuracy;
+00084     
+00085     TBool   iIsAltitudeValid;
+00086     TReal32 iAltitude;
+00087     TReal32 iAltitudeAccuracy;
+00088     
+00089     TBool   iIsSpeedValid;
+00090     TReal32 iSpeed;
+00091     TReal32 iSpeedAccuracy;
+00092     
+00093     TBool   iIsCourseValid;
+00094     TReal32 iCourse;
+00095     TReal32 iCourseAccuracy;
+00096     
+00097     TTime   iSystemTimeStamp;
+00098     
+00099     TInt    iReserved[24];
+00100     };
+00101 
+00102 
+00103 #endif //__LBSLOCATION_H__
+

Z:/lbslocator/src/lbslocationobserver.cpp File Reference

#include "lbslocationobserver.h"
+ +

Detailed Description

Z:/lbslocator/inc/lbslocationobserver.h File Reference

#include <lbslocation.h>
+ +

+ + + +

Classes
class	MLbsLocationObserver

Detailed Description

File List
File Members

Z:/lbslocator/inc/lbslocationobserver.h

00001 /*
+00002 * Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
+00003 * All rights reserved.
+00004 * This component and the accompanying materials are made available
+00005 * under the terms of "Eclipse Public License v1.0"
+00006 * which accompanies this distribution, and is available
+00007 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
+00008 *
+00009 * Initial Contributors:
+00010 * Nokia Corporation - initial contribution.
+00011 *
+00012 * Contributors:
+00013 *
+00014 * Description:
+00015 *
+00016 */
+00017 
+00018 #ifndef __LBSLOCATIONOBSERVER_H__
+00019 #define __LBSLOCATIONOBSERVER_H__
+00020 
+00027 #include <lbslocation.h>
+00028 
+00045 class MLbsLocationObserver
+00046         {
+00047 public: 
+00048         virtual void HandleLocationUpdate(const TLbsLocation& aLocation) = 0;
+00049         virtual void HandleLocationStatus(TInt aStatus);
+00050         virtual TVersion Version() const;
+00051         };
+00052 
+00053 #endif //__LBSLOCATIONOBSERVER_H__
+

Z:/lbslocator/src/lbslocator.cpp File Reference

#include "lbslocator.h"
+ +

Detailed Description

Z:/lbslocator/inc/lbslocator.h File Reference

#include <e32base.h>
+#include <lbserrors.h>
+#include <lbslocation.h>
+#include <lbsmovementevent.h>
+#include <lbslocationobserver.h>
+#include <lbsmovementobserver.h>
+ +

+ + + + + + + +

Classes
class	CLbsLocator
Variables
const TUid	KLbsProfileIdDefault = { 0x00000000 }
const TUid	KLbsProfileIdAreaMonitor = { 0x00000001 }
const TUid	KLbsProfileIdLazyTracker = { 0x00000002 }

Detailed Description

Variable Documentation

+ +

+ + + + +

const TUid KLbsProfileIdAreaMonitor = { 0x00000001 }

Accuracy of approximately 3km. Updates between 100m and 3km. See CLbsLocator::SetLocatorProfile() for more information

+ +

+ + + + +

const TUid KLbsProfileIdDefault = { 0x00000000 }

Target accuracy of 20m. Updates every second. See CLbsLocator::SetLocatorProfile() for more information

+ +

+ + + + +

const TUid KLbsProfileIdLazyTracker = { 0x00000002 }

Target accuracy of 20m. Updates when device moves 30m or more. See CLbsLocator::SetLocatorProfile() for more information

+ +

File List
File Members

Z:/lbslocator/inc/lbslocator.h

00001 /*
+00002 * Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
+00003 * All rights reserved.
+00004 * This component and the accompanying materials are made available
+00005 * under the terms of "Eclipse Public License v1.0"
+00006 * which accompanies this distribution, and is available
+00007 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
+00008 *
+00009 * Initial Contributors:
+00010 * Nokia Corporation - initial contribution.
+00011 *
+00012 * Contributors:
+00013 *
+00014 * Description:
+00015 *
+00016 */
+00017 
+00018 #ifndef __LBSLOCATOR_H__
+00019 #define __LBSLOCATOR_H__
+00020 
+00094 #include <e32base.h>
+00095 
+00096 #include <lbserrors.h>
+00097 #include <lbslocation.h>
+00098 #include <lbsmovementevent.h>
+00099 #include <lbslocationobserver.h>
+00100 #include <lbsmovementobserver.h>
+00101 
+00103 const TUid KLbsProfileIdDefault          = { 0x00000000 }; 
+00105 const TUid KLbsProfileIdAreaMonitor      = { 0x00000001 };
+00107 const TUid KLbsProfileIdLazyTracker      = { 0x00000002 };
+00108 
+00109 //Forward declarations
+00110 class CLbsLocatorImpl;
+00111 
+00138 class CLbsLocator : public CBase
+00139         {
+00140 public:
+00144     enum TLbsLocatorOption
+00145         {
+00147     ELocatorStatusTimer = 1,  
+00148         };
+00149 
+00150     IMPORT_C static CLbsLocator* NewL();
+00151     IMPORT_C static CLbsLocator* NewL(MLbsLocationObserver& aObserver);
+00152 
+00153         IMPORT_C ~CLbsLocator();
+00154 
+00155         // Select the desired profile. If none selected "TLbsProfileIdDefault" is assumed. 
+00156         IMPORT_C TInt SetLocatorProfile(TUid aProfileId);                                                                                                                                                                
+00157         IMPORT_C TUid LocatorProfile() const;
+00158 
+00159         // Start and stop requesting updates. Updates are sent to "observers" of the interface.
+00160         // StartUpdatesL() will consume resources even if there are no observers.
+00161         IMPORT_C void StartUpdatesL();
+00162         IMPORT_C void StopUpdates();
+00163 
+00164     // Modify the bahviour of the active profile.
+00165         IMPORT_C TInt SetLocatorOption(TLbsLocatorOption aOption, TInt aValue);
+00166         IMPORT_C TInt GetLocatorOption(TLbsLocatorOption aOption, TInt& aValue) const;
+00167 
+00168         // Add and Remove more position observers.
+00169         // If no observers present, then resouces may be consumed until StopUpdates() is called.
+00170         IMPORT_C void AddLocationObserverL(MLbsLocationObserver& aObserver);
+00171         IMPORT_C TInt RemoveLocationObserver(MLbsLocationObserver& aObserver);
+00172 
+00173     IMPORT_C void AddMovementObserverL(MLbsMovementObserver& aObserver);
+00174         IMPORT_C TInt RemoveMovementObserver(MLbsMovementObserver& aObserver);
+00175         
+00176 private:
+00177         CLbsLocator();
+00178         void ConstructL(MLbsLocationObserver* aObserver);
+00179         
+00180         CLbsLocatorImpl *iImpl;
+00181         };
+00182 
+00183 #endif //__LBSLOCATOR_H__
+00184 
+

Z:/lbslocator/src/lbslocatorclasstypes.cpp File Reference

#include <lbslocatorclasstypes.h>
+ +

Detailed Description

Z:/lbslocator/inc/lbslocatorclasstypes.h File Reference

#include <e32base.h>
+ +

+ + + + + +

Classes
class	TLbsLocatorClassTypeBase
Enumerations
enum	TLbsLocatorClassTypes { ELbsLocatorBaseClassType = 0x01, +ELbsLocationClassType = 0x02, +ELbsMovementEventClassType = 0x04 + }

Detailed Description

File List
File Members

Z:/lbslocator/inc/lbslocatorclasstypes.h

00001 /*
+00002 * Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
+00003 * All rights reserved.
+00004 * This component and the accompanying materials are made available
+00005 * under the terms of "Eclipse Public License v1.0"
+00006 * which accompanies this distribution, and is available
+00007 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
+00008 *
+00009 * Initial Contributors:
+00010 * Nokia Corporation - initial contribution.
+00011 *
+00012 * Contributors:
+00013 *
+00014 * Description:
+00015 *
+00016 */
+00017 
+00018 #ifndef __LBSLOCATORCLASSTYPES_H__
+00019 #define __LBSLOCATORCLASSTYPES_H__
+00020 
+00021 #include <e32base.h>
+00022 
+00029 enum TLbsLocatorClassTypes
+00030     {
+00031     ELbsLocatorBaseClassType   = 0x01,
+00032     ELbsLocationClassType      = 0x02,
+00033     ELbsMovementEventClassType = 0x04
+00034     };
+00035 
+00041 class TLbsLocatorClassTypeBase
+00042     {
+00043 public:
+00044     IMPORT_C TUint32 LocatorClassType() const;
+00045 
+00046     IMPORT_C TUint LocatorClassSize() const;
+00047 
+00048 protected:
+00049     TLbsLocatorClassTypeBase();
+00050 
+00051 protected:
+00053     TUint32 iClassType;
+00055     TUint iClassSize;
+00056     };
+00057 
+00058 #endif //__LBSLOCATORCLASSTYPES_H__
+

Z:/lbslocator/src/lbsmovementevent.cpp File Reference

#include <lbsmovementevent.h>
+ +

Detailed Description

Z:/lbslocator/inc/lbsmovementevent.h File Reference

#include <e32base.h>
+#include <lbslocatorclasstypes.h>
+ +

+ + + +

Classes
class	TLbsMovementEvent

Detailed Description

File List
File Members

Z:/lbslocator/inc/lbsmovementevent.h

00001 /*
+00002 * Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
+00003 * All rights reserved.
+00004 * This component and the accompanying materials are made available
+00005 * under the terms of "Eclipse Public License v1.0"
+00006 * which accompanies this distribution, and is available
+00007 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
+00008 *
+00009 * Initial Contributors:
+00010 * Nokia Corporation - initial contribution.
+00011 *
+00012 * Contributors:
+00013 *
+00014 * Description:
+00015 *
+00016 */
+00017 
+00018 #ifndef __LBSMOVEMENTEVENT_H__
+00019 #define __LBSMOVEMENTEVENT_H__
+00020 
+00021 #include <e32base.h>
+00022 #include <lbslocatorclasstypes.h>
+00023 
+00046 class TLbsMovementEvent : public TLbsLocatorClassTypeBase
+00047     {
+00048 public:
+00053     enum TLbsMovementEventType
+00054         {
+00055         EMovementEventUnknown    = 0,
+00056     EMovementEventStationary = 1,
+00057         EMovementEventMoving     = 2,
+00058         EMovementEventWalking    = 4,
+00059         EMovementEventLastBit    = 1 << 31
+00060         };
+00061 
+00062     IMPORT_C TLbsMovementEvent();
+00063 
+00064     IMPORT_C TLbsMovementEventType MovementEvent() const;        
+00065     IMPORT_C TTime SystemTimeStamp() const;        
+00066 
+00067         IMPORT_C void SetMovementEvent(TLbsMovementEventType aEvent);   
+00068     IMPORT_C TInt SetSystemTimeStamp(TTime aTimeStamp);
+00069   
+00070 private:
+00071     TLbsMovementEventType iEvent;
+00072     TTime   iSystemTimeStamp;
+00073     TInt    iReserved[24];
+00074     };
+00075 
+00076 
+00077 #endif //__LBSMOVEMENTEVENT_H__
+

Z:/lbslocator/src/lbsmovementobserver.cpp File Reference

#include "lbsmovementobserver.h"
+ +

Detailed Description

Z:/lbslocator/inc/lbsmovementobserver.h File Reference

#include <e32base.h>
+#include <lbsmovementevent.h>
+ +

+ + + +

Classes
class	MLbsMovementObserver

Detailed Description

File List
File Members

Z:/lbslocator/inc/lbsmovementobserver.h