srsfenginestub/common/inc/asrshwdevice.h
changeset 0 0ce1b5ce9557
equal deleted inserted replaced
-1:000000000000 0:0ce1b5ce9557
       
     1 /*
       
     2 * Copyright (c) 2004 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:     TTP hardware device
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 #ifndef ASRHWDEVICE_H
       
    24 #define ASRHWDEVICE_H
       
    25 
       
    26 //  INCLUDES
       
    27 #include <e32base.h>
       
    28  
       
    29 // CLASS DECLARATION
       
    30 
       
    31 /**
       
    32 *  Base class for all hw devices
       
    33 *   
       
    34 *
       
    35 *  @lib asrsadaptationhwdevice.lib
       
    36 *  @since 2.8
       
    37 */
       
    38 class CASRSHwDevice : public CBase
       
    39     {
       
    40     public:  // Constructors and destructor
       
    41         
       
    42         /**
       
    43         * Two-phased constructor.
       
    44         */
       
    45         IMPORT_C static CASRSHwDevice* NewL();
       
    46         
       
    47         /**
       
    48         * Destructor.
       
    49         */
       
    50         IMPORT_C virtual ~CASRSHwDevice();
       
    51 
       
    52     public: // New functions
       
    53         
       
    54         /**
       
    55         * Use to initilize HW device
       
    56         * @since 2.8
       
    57         * @param none
       
    58         * @return none
       
    59         */
       
    60         IMPORT_C virtual void InitializeL();
       
    61 
       
    62         /**
       
    63         * Use to clear HW device
       
    64         * @since 2.8
       
    65         * @param none
       
    66         * @return none
       
    67         */
       
    68         IMPORT_C virtual void Clear();
       
    69 
       
    70 		/**
       
    71         * Use to get custom interface
       
    72         * @since 2.8
       
    73         * @param aInterfaceId Identifier of the intercace implementation
       
    74         * @return Pointer to the interface implementation or NULL.
       
    75         */
       
    76         IMPORT_C virtual TAny* CustomInterface( TUid aInterfaceId );
       
    77 
       
    78     public: // Functions from base classes
       
    79 
       
    80         /**
       
    81         * From ?base_class ?member_description.
       
    82         * @since ?Series60_version
       
    83         * @param ?arg1 ?description
       
    84         * @return ?description
       
    85         */
       
    86         //?type ?member_function( ?type ?arg1 );
       
    87         
       
    88     protected:  // New functions
       
    89         
       
    90         /**
       
    91         * ?member_description.
       
    92         * @since ?Series60_version
       
    93         * @param ?arg1 ?description
       
    94         * @return ?description
       
    95         */
       
    96         //?type ?member_function( ?type ?arg1 );
       
    97 
       
    98     protected:  // Functions from base classes
       
    99         
       
   100         /**
       
   101         * From ?base_class ?member_description
       
   102         */
       
   103         //?type ?member_function();
       
   104 
       
   105 
       
   106 
       
   107         /**
       
   108         * C++ default constructor.
       
   109         */
       
   110         CASRSHwDevice();
       
   111 
       
   112     private:
       
   113         /**
       
   114         * By default Symbian 2nd phase constructor is private.
       
   115         */
       
   116         void ConstructL();
       
   117 
       
   118         // Prohibit copy constructor if not deriving from CBase.
       
   119         // ?classname( const ?classname& );
       
   120         // Prohibit assigment operator if not deriving from CBase.
       
   121         // ?classname& operator=( const ?classname& );
       
   122 
       
   123     public:     // Data
       
   124         // ?one_line_short_description_of_data
       
   125         //?data_declaration;
       
   126     
       
   127     protected:  // Data
       
   128         // ?one_line_short_description_of_data
       
   129         //?data_declaration;
       
   130 
       
   131     private:    // Data
       
   132         // ?one_line_short_description_of_data
       
   133         //?data_declaration;
       
   134          
       
   135         // Reserved pointer for future extension
       
   136         //TAny* iReserved;
       
   137 
       
   138     public:     // Friend classes
       
   139         //?friend_class_declaration;
       
   140     protected:  // Friend classes
       
   141         //?friend_class_declaration;
       
   142     private:    // Friend classes
       
   143         //?friend_class_declaration;
       
   144 
       
   145     };
       
   146 
       
   147 #endif      // ?INCLUDE_H   
       
   148             
       
   149 // End of File