mds_plat/location_manager_api/inc/rlocationmanager.h
author hgs
Wed, 06 Oct 2010 15:08:08 +0300
changeset 60 79f826a55db2
permissions -rw-r--r--
201039
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
60
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  An interface to Location Manager
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef R_RLOCATIONMANAGER_H
hgs
parents:
diff changeset
    19
#define R_RLOCATIONMANAGER_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include <e32base.h>
hgs
parents:
diff changeset
    22
#include <lbsposition.h>
hgs
parents:
diff changeset
    23
#include <etel3rdparty.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
/**
hgs
parents:
diff changeset
    26
 *  Base class for Location Manager client interfaces.
hgs
parents:
diff changeset
    27
 *  @lib LocationManager.lib
hgs
parents:
diff changeset
    28
 *  @since S60 3.1
hgs
parents:
diff changeset
    29
 */
hgs
parents:
diff changeset
    30
NONSHARABLE_CLASS( RLocationManager ) : public RSessionBase
hgs
parents:
diff changeset
    31
    {
hgs
parents:
diff changeset
    32
public:
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
    /**
hgs
parents:
diff changeset
    35
     * C++ default constructor.
hgs
parents:
diff changeset
    36
     * @since S60 3.1
hgs
parents:
diff changeset
    37
     */
hgs
parents:
diff changeset
    38
    IMPORT_C RLocationManager();
hgs
parents:
diff changeset
    39
    
hgs
parents:
diff changeset
    40
    /**
hgs
parents:
diff changeset
    41
     * Creates new session to Location Manager Server.
hgs
parents:
diff changeset
    42
     * @since S60 3.1
hgs
parents:
diff changeset
    43
     * @param None.
hgs
parents:
diff changeset
    44
     * @return KErrNone if successful.
hgs
parents:
diff changeset
    45
     */
hgs
parents:
diff changeset
    46
    IMPORT_C TInt Connect();
hgs
parents:
diff changeset
    47
    
hgs
parents:
diff changeset
    48
    /**
hgs
parents:
diff changeset
    49
     * Closes the connection with Location Manager Server
hgs
parents:
diff changeset
    50
     * @since S60 3.1
hgs
parents:
diff changeset
    51
     * @param None.
hgs
parents:
diff changeset
    52
     */
hgs
parents:
diff changeset
    53
    IMPORT_C void Close();
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
private:
hgs
parents:
diff changeset
    56
    /**
hgs
parents:
diff changeset
    57
     * Returns the version of Location Manager.
hgs
parents:
diff changeset
    58
     */
hgs
parents:
diff changeset
    59
    TVersion Version() const;
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
protected:
hgs
parents:
diff changeset
    62
	/**
hgs
parents:
diff changeset
    63
	 * Completes an asynchronous request with an error code.
hgs
parents:
diff changeset
    64
	 * @param aError Symbian error code
hgs
parents:
diff changeset
    65
	 */
hgs
parents:
diff changeset
    66
	void CompleteRequest(TRequestStatus& aStatus, TInt aError);
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
    };
hgs
parents:
diff changeset
    69
    
hgs
parents:
diff changeset
    70
#endif // R_RLOCATIONMANAGER_H
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
//End of File