homescreensrv_plat/servicemodel_api/servicebase.h
author hgs
Wed, 24 Mar 2010 13:06:03 +0200
changeset 90 0e41c72311af
parent 85 7feec50967db
permissions -rw-r--r--
201011_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
85
7feec50967db 201003_02
hgs
parents:
diff changeset
     1
/*
7feec50967db 201003_02
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
7feec50967db 201003_02
hgs
parents:
diff changeset
     3
* All rights reserved.
7feec50967db 201003_02
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
7feec50967db 201003_02
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
7feec50967db 201003_02
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
7feec50967db 201003_02
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
7feec50967db 201003_02
hgs
parents:
diff changeset
     8
*
7feec50967db 201003_02
hgs
parents:
diff changeset
     9
* Initial Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
7feec50967db 201003_02
hgs
parents:
diff changeset
    11
*
7feec50967db 201003_02
hgs
parents:
diff changeset
    12
* Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    13
*
7feec50967db 201003_02
hgs
parents:
diff changeset
    14
* Description:  HsService base 
7feec50967db 201003_02
hgs
parents:
diff changeset
    15
*
7feec50967db 201003_02
hgs
parents:
diff changeset
    16
*/
7feec50967db 201003_02
hgs
parents:
diff changeset
    17
7feec50967db 201003_02
hgs
parents:
diff changeset
    18
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#ifndef SERVICEBASE_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
#define SERVICEBASE_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
struct HsServiceInterfaceId;
7feec50967db 201003_02
hgs
parents:
diff changeset
    23
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
/** @ingroup group_hsservicemodel group_service_api_candidates
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
 *  The base class for service interfaces
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
 *  @lib 
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
 *  @since S60 ?S60_version
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
class IHsServiceBase
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
    {
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
    
7feec50967db 201003_02
hgs
parents:
diff changeset
    33
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    35
     * Default virtual destructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
    virtual ~IHsServiceBase() {}
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
7feec50967db 201003_02
hgs
parents:
diff changeset
    39
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
     * Interface getter with casting.
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
     * @since S60 ?S60_version
7feec50967db 201003_02
hgs
parents:
diff changeset
    43
     * @param aBase HsService base object.
7feec50967db 201003_02
hgs
parents:
diff changeset
    44
     * @return The queried interface, or NULL if the interface is not
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
     *         supported or available.
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
    template <class T>
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
    static T* MakeInterface(IHsServiceBase* aBase)
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
        {
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
        return (aBase? static_cast<T*>(aBase->resolveService(T::type())): 0);    
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
        }
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
        
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
    
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
     * Interface getter.
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
     * Derived classes should always call the base class method
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
     * from the overridden MakeInterface.
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
     * @since S60 ?S60_version
7feec50967db 201003_02
hgs
parents:
diff changeset
    60
     * @param aType The type id of the queried interface.
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
     * @return The queried interface, or NULL if the interface is not
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
     *         supported or available.
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
    virtual IHsServiceBase* resolveService( const HsServiceInterfaceId &aType ) = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
    
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
    
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
    };
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
#endif