williamr@2: // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies). williamr@2: // All rights reserved. williamr@2: // This component and the accompanying materials are made available williamr@4: // under the terms of "Eclipse Public License v1.0" williamr@2: // which accompanies this distribution, and is available williamr@4: // at the URL "http://www.eclipse.org/legal/epl-v10.html". williamr@2: // williamr@2: // Initial Contributors: williamr@2: // Nokia Corporation - initial contribution. williamr@2: // williamr@2: // Contributors: williamr@2: // williamr@2: // Description: williamr@2: // williamr@2: williamr@2: #ifndef __LBS_H__ williamr@2: #define __LBS_H__ williamr@2: williamr@2: #include williamr@4: #include williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: williamr@2: // Forward declarations williamr@2: class CPositioningPtrHolder; williamr@2: class CServerPositioningPtrHolder; williamr@2: class RPositionServer : public RSessionBase williamr@2: williamr@2: /** williamr@2: This is generally the first interface class used by all client applications. williamr@2: It is used to make the primary connection to the location server. After the williamr@2: primary connection has been established, its handle is passed as a parameter williamr@2: of the Open methods of RPositioner to create a "sub-session". williamr@2: williamr@2: The RPositionServer class can also be used to discover what position williamr@2: technology "modules" are available. However, this is only required if a williamr@4: client application actually needs to use a particular module. It is also williamr@4: used for requests to clear(empty) the last known position store. williamr@4: williamr@4: Asynchronous requests can be cancelled using the method CancelRequest() with williamr@4: a value from the enumeration _TReqestId corresponding to the particular williamr@4: operation being cancelled. williamr@2: williamr@2: @publishedAll williamr@2: @released williamr@2: */ williamr@2: { williamr@2: public: williamr@4: /** Type for values defined in _TRequestId williamr@4: @publishedPartner williamr@4: @prototype*/ williamr@4: typedef TInt TRequestId; williamr@4: williamr@4: /** Identification numbers used for cancelling requests. williamr@4: Note that the TRequestId enum may be extended in the future by adding williamr@4: more enumerated values. To maintain compatibility any unrecognized values williamr@4: must be handled as EReqUnknown. williamr@4: @publishedPartner williamr@4: @prototype*/ williamr@4: enum _TRequestId williamr@4: { williamr@4: /** Unknown/undefined Id */ williamr@4: EReqUnknown = 0, williamr@4: /** The id of the RPositionServer::NotifyModuleStatusEvent request */ williamr@4: EReqNotifyModuleStatusEvent = 1, williamr@4: /** The id of the RPositionServer::EmptyLastKnownPositionStore request */ williamr@4: EReqEmptyLastKnownPositionStore = 2 williamr@4: }; williamr@4: williamr@4: public: williamr@2: IMPORT_C RPositionServer(); williamr@2: williamr@2: IMPORT_C TInt Connect(); williamr@2: IMPORT_C void Close(); williamr@2: williamr@4: IMPORT_C TInt CancelRequest(TRequestId aRequestId); williamr@2: IMPORT_C TVersion Version() const; williamr@2: williamr@2: IMPORT_C TInt GetDefaultModuleId(TPositionModuleId& aModuleId) const; williamr@2: IMPORT_C TInt GetNumModules(TUint& aNumModules) const; williamr@2: IMPORT_C TInt GetModuleInfoByIndex(TInt aModuleIndex, williamr@2: TPositionModuleInfoBase& aModuleInfo) const; williamr@2: IMPORT_C TInt GetModuleInfoById(TPositionModuleId aModuleId, williamr@2: TPositionModuleInfoBase& aModuleInfo) const; williamr@2: williamr@2: IMPORT_C TInt GetModuleStatus(TPositionModuleStatusBase& aPosModuleStatus, williamr@2: TPositionModuleId aModuleId) const; williamr@2: williamr@2: IMPORT_C void NotifyModuleStatusEvent(TPositionModuleStatusEventBase& aStatusEvent, williamr@2: TRequestStatus& aStatus, williamr@2: const TPositionModuleId aModuleId = KPositionNullModuleId) const; williamr@4: williamr@4: IMPORT_C void EmptyLastKnownPositionStore(TRequestStatus& aStatus); williamr@2: williamr@2: private: williamr@2: void ConstructL(); williamr@2: void Destruct(); williamr@2: static TInt StartServer(); williamr@2: williamr@2: private: williamr@2: /** A pointer to a container that holds pointer descriptors, needed to point williamr@2: to the clients request data during asynchronous requests */ williamr@2: CServerPositioningPtrHolder* iPtrHolder; williamr@2: williamr@2: /** Variable for future expansion. */ williamr@2: TAny* iReserved; williamr@2: }; williamr@2: williamr@2: williamr@2: class RPositionerSubSessionBase : public RSubSessionBase williamr@2: /** williamr@2: Abstract base class for all positioning sub-sessions, including RPositioner. williamr@2: williamr@4: Asynchronous requests issued from derived classess are cancelled using the williamr@4: method CancelRequest() with a value from the enumeration _TReqestId corresponding williamr@4: to the particular operation being cancelled. williamr@4: williamr@2: @see RPositioner williamr@2: @publishedAll williamr@2: @released williamr@2: */ williamr@2: { williamr@4: williamr@2: public: williamr@4: williamr@4: /** Type for values defined in _TRequestId williamr@4: @publishedPartner williamr@4: @prototype*/ williamr@4: typedef TInt TRequestId; williamr@4: williamr@4: /** Identification numbers used for cancelling requests. williamr@4: Note that the TRequestId enum may be extended in the future by adding williamr@4: more enumerated values. To maintain compatibility any unrecognized values williamr@4: must be handled as EReqUnknown. williamr@4: @publishedPartner williamr@4: @prototype*/ williamr@4: enum _TRequestId williamr@4: { williamr@4: /** Unknown/undefined Id */ williamr@4: EReqUnknown = 0, williamr@4: /** The id of the GetLastKnownPosition request */ williamr@4: EReqGetLastKnownPosition = 1, williamr@4: /** The id of the GetLastKnownPositionArea request */ williamr@4: EReqGetLastKnownPositionArea = 2, williamr@4: /** The id of the ReqNotifyPositionUpdate request */ williamr@4: EReqNotifyPositionUpdate = 3 williamr@4: }; williamr@4: public: williamr@4: IMPORT_C TInt CancelRequest(TRequestId aRequestId); williamr@2: williamr@2: IMPORT_C TInt CompleteRequest(TInt aRequestId); williamr@2: williamr@2: protected: williamr@2: IMPORT_C RPositionerSubSessionBase(); williamr@2: williamr@2: IMPORT_C virtual TAny* ExtendedInterface(TInt aFunctionNumber, TAny* aPtr1, TAny* aPtr2); williamr@2: williamr@2: private: williamr@2: /** Unused variable for future expansion. */ williamr@2: TAny* iReserved; williamr@2: }; williamr@2: williamr@2: williamr@2: class RPositioner : public RPositionerSubSessionBase williamr@2: /** williamr@2: This class is used to create a sub-session with the server for the williamr@2: purpose of obtaining the current position. In addition to actually williamr@2: obtaining position information, this class also provides mechanisms williamr@4: for obtaining the last known position, the last known position with williamr@4: area information, the general status of the positioning module, williamr@4: changing how often it wishes to receive position updates, as well as williamr@4: identifying itself to the location framework. williamr@2: williamr@2: Before using the class, a primary connection must have already been williamr@2: established with the server. williamr@2: williamr@2: @see RPositionServer williamr@2: @publishedAll williamr@2: @released williamr@2: */ williamr@2: { williamr@4: williamr@2: public: williamr@2: IMPORT_C RPositioner(); williamr@2: williamr@2: IMPORT_C TInt Open(RPositionServer& aPosServer); williamr@2: IMPORT_C TInt Open(RPositionServer& aPosServer, williamr@2: TPositionModuleId aModuleId); williamr@2: IMPORT_C TInt Open(RPositionServer& aPosServer, williamr@2: const TPositionCriteriaBase& aCriteria); williamr@2: IMPORT_C void Close(); williamr@2: williamr@2: IMPORT_C TInt SetRequestor(CRequestor::TRequestorType aType, williamr@2: CRequestor::TRequestorFormat aFormat, williamr@2: const TDesC& aData); williamr@2: IMPORT_C TInt SetRequestor(const RRequestorStack& aRequestorStack); williamr@2: williamr@2: IMPORT_C TInt SetUpdateOptions(const TPositionUpdateOptionsBase& aPosOption); williamr@2: IMPORT_C TInt GetUpdateOptions(TPositionUpdateOptionsBase& aPosOption) const; williamr@2: williamr@2: IMPORT_C void GetLastKnownPosition(TPositionInfoBase& aPosInfo, williamr@2: TRequestStatus& aStatus) const; williamr@4: williamr@4: IMPORT_C void GetLastKnownPositionArea(TPositionInfoBase& aPosInfo, williamr@4: TPositionAreaInfoBase& aAreaInfo, williamr@4: TRequestStatus& aStatus) const; williamr@4: williamr@2: IMPORT_C void NotifyPositionUpdate(TPositionInfoBase& aPosInfo, williamr@2: TRequestStatus& aStatus) const; williamr@2: williamr@2: protected: williamr@2: IMPORT_C virtual void ConstructL(); williamr@2: IMPORT_C virtual void Destruct(); williamr@2: IMPORT_C virtual TAny* ExtendedInterface(TInt aFunctionNumber, TAny* aPtr1, TAny* aPtr2); williamr@2: williamr@2: public: williamr@2: TInt OpenImpl(RPositionServer& aPosServer, TPositionModuleId aModuleId, const TPositionCriteriaBase& aCriteria, TBool aOpenedUsingModuleId); williamr@2: private: williamr@2: /** A pointer to a container that holds pointer descriptors, needed to point williamr@2: to the clients request data during asynchronous requests */ williamr@2: CPositioningPtrHolder* iPtrHolder; williamr@2: /** Unused variable for future expansion. */ williamr@2: TAny* iReserved; williamr@2: }; williamr@2: williamr@2: williamr@2: #include williamr@2: williamr@2: #endif // __LBS_H__