1 /*

     2 * Copyright (c) 2007 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:  SDK/S60, Landmarks API

    15 *

    16 */

    17 

    18 

    19 #ifndef EPOS_CPOSLMDATABASEFASTCOUNTERS_H_

    20 #define EPOS_CPOSLMDATABASEFASTCOUNTERS_H_

    21 

    22 /**

    23  *  Landmark database extension interface to access fast counters.

    24  *

    25  *  This class defines methods, which are able to return following data fast:

    26  *   - total amount of landmarks, @ref LandmarksCount()

    27  *   - total amount of landmark categories, @ref CategoriesCount()

    28  *   - amount of uncategorized landmarks, @ref UncategorizedLandmarksCount()

    29  *   - amount of unreferenced landmark categories, @ref UnrferencedCategoriesCount()

    30  *

    31  *  @see CPosLandmarkDatabaseExtended

    32  *  @see CPosLandmarkDatabaseExtended::GetExtensionL

    33  *  @since S60 3.2

    34  *  @lib eposlandmarks.lib.

    35  */

    36 class MPosLmDatabaseFastCounters

    37     {

    38     public:

    39 

    40         /** Returns total amount of landmarks in the database.

    41          *  @return Number of landmarks in the database or negative error code:

    42          *      - KErrNotSupported if not supported in current database.

    43          *      - KErrPosLmNotInitialized if database is not yet initialized. */

    44         virtual TInt TotalLandmarksCount() = 0;

    45 

    46         /** Returns total amount of landmark categories in the database.

    47          *  @return Number of landmark categories in the database or negative error code:

    48          *      - KErrNotSupported if not supported in current database.

    49          *      - KErrPosLmNotInitialized if database is not yet initialized. */

    50         virtual TInt TotalCategoriesCount() = 0;

    51         

    52         /** Returns amount of categorized landmarks in the database.

    53          *  @return Number of categorized landmarks in the database or negative error code:

    54          *      - KErrNotSupported if not supported in current database.

    55          *      - KErrPosLmNotInitialized if database is not yet initialized. */

    56         virtual TInt CategorizedLandmarksCount() = 0;

    57 

    58         /** Returns total amount of referenced landmark categories in the database.

    59          *  @return Number of referenced landmark categories in the database 

    60          *          or negative error code:

    61          *      - KErrNotSupported if not supported in current database.

    62          *      - KErrPosLmNotInitialized if database is not yet initialized. */

    63         virtual TInt ReferencedCategoriesCount() = 0;

    64 

    65         /** Returns amount of uncategorized (not assigned to any category) 

    66          *  landmarks in the database.

    67          *  @return Number of uncategorized landmarks in the database or negative error code:

    68          *      - KErrNotSupported if not supported in current database.

    69          *      - KErrPosLmNotInitialized if database is not yet initialized. */

    70         virtual TInt UncategorizedLandmarksCount() = 0;

    71 

    72         /** Returns total amount of unreferenced (not used by any landmark) 

    73          *  landmark categories in the database.

    74          *  @return Number of unreferenced landmark categories in the database 

    75          *          or negative error code:

    76          *      - KErrNotSupported if not supported in current database.

    77          *      - KErrPosLmNotInitialized if database is not yet initialized. */

    78         virtual TInt UnreferencedCategoriesCount() = 0;

    79     };

    80 

    81 

    82 #endif /*EPOS_CPOSLMDATABASEFASTCOUNTERS_H_*/