datasourceadaptation/gpsdatasourceadaptation/inc/epos_mposmodulestatusmanager.h
changeset 0 9cfd9a3ee49c
equal deleted inserted replaced
-1:000000000000 0:9cfd9a3ee49c
       
     1 /*
       
     2 * Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef EPOS_MPOSMODULESTATUSMANAGER_H
       
    21 #define EPOS_MPOSMODULESTATUSMANAGER_H
       
    22 
       
    23 #include <lbs.h>
       
    24 
       
    25 class MPosModuleStatusListener;
       
    26 
       
    27 /**
       
    28 *  This is an interface through which a PSY can get module settings and listen
       
    29 *  to module settings change.
       
    30 * 
       
    31 */
       
    32 class MPosModuleStatusManager
       
    33     {
       
    34     public:
       
    35         /**
       
    36         * Add a listener to get the module status change event. 
       
    37         *
       
    38         * The listener must be removed when the client does not want to get
       
    39         * module status change event any more.
       
    40         *
       
    41         * @param aListener The reference to listener class.
       
    42         */
       
    43         virtual void AddListenerL(
       
    44             MPosModuleStatusListener& aListener ) = 0;
       
    45 
       
    46         /**
       
    47         * Remove a listener of module status chagne event.
       
    48         *
       
    49         * If the listener has not been added, this function does nothing.
       
    50         *
       
    51         * @param aListener The reference to the listener class.
       
    52         */
       
    53         virtual void RemoveListener(
       
    54             MPosModuleStatusListener& aListener) = 0;
       
    55 
       
    56         /**
       
    57         * Obtains information about the specified positioning module.
       
    58         *
       
    59         * @param[out] aStatus contains, on successful completion, the status of
       
    60         * the specified positioning module
       
    61         * @param aModuleId the unique identifier (UID) of a positioning module
       
    62         * @return a symbian OS error code.
       
    63         * @return KErrNotFound is returned if the specified moduleId is not valid.
       
    64         */
       
    65         virtual TInt GetModuleStatus(
       
    66             const TPositionModuleId& aModuleId,
       
    67             TPositionModuleStatusBase& aStatus ) const = 0;
       
    68     };  
       
    69 
       
    70 #endif  // EPOS_MPOSMODULESTATUSMANAGER_H