bluetoothengine/headsetsimulator/core/inc/Plugin/hscodpluginbase.h
author michal.sulewski
Wed, 15 Sep 2010 15:59:44 +0200
branchheadsetsimulator
changeset 60 90dbfc0435e3
permissions -rw-r--r--
source code commit
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
60
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     1
/*
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     2
 * Component Name: Headset Simulator
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     3
 * Author: Comarch S.A.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     4
 * Version: 1.0
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     5
 * Copyright (c) 2010 Comarch S.A.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     6
 *  
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     7
 * This Software is submitted by Comarch S.A. to Symbian Foundation Limited on 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     8
 * the basis of the Member Contribution Agreement entered between Comarch S.A. 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     9
 * and Symbian Foundation Limited on 5th June 2009 (“Agreement”) and may be 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    10
 * used only in accordance with the terms and conditions of the Agreement. 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    11
 * Any other usage, duplication or redistribution of this Software is not 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    12
 * allowed without written permission of Comarch S.A.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    13
 * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    14
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    15
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    16
#ifndef HSCODPLUGINBASE_H_
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    17
#define HSCODPLUGINBASE_H_
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    18
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    19
#include <ecom.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    20
#include <btdevice.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    21
#include <e32property.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    22
#include <bt_subscribe.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    23
#include <hsecompluginbase.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    24
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    25
/**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    26
 * CoD plugin UID
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    27
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    28
const TUid KHsCoDBaseInterfaceDefinitionUid =
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    29
    {
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    30
    0xE0009DC2
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    31
    };
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    32
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    33
/**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    34
 * @brief Abstract methods for CoD plugin
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    35
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    36
class MHsCoDBase
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    37
{
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    38
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    39
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    40
     * Destructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    41
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    42
    virtual ~MHsCoDBase() { };
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    43
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    44
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    45
     * Sets new Class of Device in properties registry
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    46
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    47
    virtual void SetNewCodL() = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    48
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    49
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    50
     * Restores Class of Device  
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    51
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    52
     * @return error code value
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    53
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    54
    virtual TInt RestoreOldCod() = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    55
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    56
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    57
     * Saves old CoD
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    58
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    59
     * @return error code value
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    60
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    61
    virtual TInt SaveOldCod() = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    62
};
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    63
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    64
/**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    65
 * @brief Class allows to set new CoD. Each CoD plugin should derive from this class. 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    66
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    67
class CHsCoDBase : protected CHsEComPluginBase, public MHsCoDBase
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    68
{
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    69
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    70
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    71
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    72
     * Two-phase constructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    73
     * @param aUid plugin's UID
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    74
     * @return instance of class
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    75
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    76
    static CHsCoDBase* NewL( const TUid aUid );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    77
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    78
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    79
     * Two-phase constructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    80
     * @param aData plugin's name
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    81
     * @return instance of class
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    82
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    83
    static CHsCoDBase* NewL( const TDesC8 &aData );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    84
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    85
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    86
     * Destructor.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    87
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    88
    virtual ~CHsCoDBase();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    89
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    90
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    91
    //Methods inherited from MHsCoDBase
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    92
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    93
    virtual void SetNewCodL() = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    94
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    95
    virtual TInt RestoreOldCod();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    96
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    97
    virtual TInt SaveOldCod();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    98
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    99
protected:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   100
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   101
     * Restores Class of Device
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   102
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   103
     * @return error code value
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   104
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   105
    TInt SetDefaultCod();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   106
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   107
    /** Default Class of Device */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   108
    TUint32 iDefaultDeviceClass;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   109
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   110
};
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   111
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   112
#include "hscodpluginbase.inl"
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   113
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   114
#endif /* HSCODPLUGINBASE_H_ */