usbuis/usbuinotif/tsrc/usbuinotifapitest/inc/usbuinotifapitest.h
author hgs
Mon, 17 May 2010 11:03:15 +0300
changeset 52 831068540b07
parent 46 0ffee699d6c7
child 58 c3241a5ac9ff
permissions -rw-r--r--
201019_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
44
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
46
hgs
parents: 44
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
44
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
46
hgs
parents: 44
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
44
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef USBUINOTIFAPITEST_H
hgs
parents:
diff changeset
    19
#define USBUINOTIFAPITEST_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
//  INCLUDES
hgs
parents:
diff changeset
    22
#include <StifLogger.h>
hgs
parents:
diff changeset
    23
#include <TestScripterInternal.h>
hgs
parents:
diff changeset
    24
#include <StifTestModule.h>
hgs
parents:
diff changeset
    25
#include <TestclassAssert.h>
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
#include <usbuinotif.h>
hgs
parents:
diff changeset
    28
#include <usbpersonalityids.h>
hgs
parents:
diff changeset
    29
#include <centralrepository.h>
hgs
parents:
diff changeset
    30
#include <UsbWatcherInternalCRKeys.h>
hgs
parents:
diff changeset
    31
#include <usbman.h>
hgs
parents:
diff changeset
    32
#include <usbwatcher.h>
hgs
parents:
diff changeset
    33
#include <usb/hostms/srverr.h> 
hgs
parents:
diff changeset
    34
// CONSTANTS
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
// MACROS
hgs
parents:
diff changeset
    37
#define TEST_CLASS_VERSION_MAJOR 0
hgs
parents:
diff changeset
    38
#define TEST_CLASS_VERSION_MINOR 0
hgs
parents:
diff changeset
    39
#define TEST_CLASS_VERSION_BUILD 0
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
// Logging path
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
    42
_LIT( KUSBUiNotifApiTestLogPath, "e:\\testing\\stiflogs\\" ); 
44
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
// Log file
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
    45
_LIT( KUSBUiNotifApiTestLogFile, "USBUiNotifApiTest.txt" ); 
831068540b07 201019_1
hgs
parents: 46
diff changeset
    46
_LIT( KUSBUiNotifApiTestLogFileWithTitle, "USBUiNotifApiTest_[%S].txt" );
44
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
// FUNCTION PROTOTYPES
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
// FORWARD DECLARATIONS
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
    51
class CUSBUiNotifApiTest;
44
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
// DATA TYPES
hgs
parents:
diff changeset
    54
enum TTestOption
hgs
parents:
diff changeset
    55
    {
hgs
parents:
diff changeset
    56
    EQueryDiscarded = 0,
hgs
parents:
diff changeset
    57
    EQueryAccepted,
hgs
parents:
diff changeset
    58
    EQueryCanceled
hgs
parents:
diff changeset
    59
    };
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
// CLASS DECLARATION
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
/**
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
    64
*  CUSBUiNotifApiTest test class for STIF Test Framework TestScripter.
44
hgs
parents:
diff changeset
    65
*  ?other_description_lines
hgs
parents:
diff changeset
    66
*
hgs
parents:
diff changeset
    67
*  @lib ?library
hgs
parents:
diff changeset
    68
*  @since ?Series60_version
hgs
parents:
diff changeset
    69
*/
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
    70
NONSHARABLE_CLASS(CUSBUiNotifApiTest) : public CScriptBase
44
hgs
parents:
diff changeset
    71
    {
hgs
parents:
diff changeset
    72
    public:  // Constructors and destructor
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
        /**
hgs
parents:
diff changeset
    75
        * Two-phased constructor.
hgs
parents:
diff changeset
    76
        */
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
    77
        static CUSBUiNotifApiTest* NewL( CTestModuleIf& aTestModuleIf );
44
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
        /**
hgs
parents:
diff changeset
    80
        * Destructor.
hgs
parents:
diff changeset
    81
        */
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
    82
        virtual ~CUSBUiNotifApiTest();
44
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
    public: // New functions
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
    public: // Functions from base classes
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
        /**
hgs
parents:
diff changeset
    89
        * From CScriptBase Runs a script line.
hgs
parents:
diff changeset
    90
        * @since ?Series60_version
hgs
parents:
diff changeset
    91
        * @param aItem Script line containing method name and parameters
hgs
parents:
diff changeset
    92
        * @return Symbian OS error code
hgs
parents:
diff changeset
    93
        */
hgs
parents:
diff changeset
    94
        virtual TInt RunMethodL( CStifItemParser& aItem );
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
    protected:  // New functions
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
    protected:  // Functions from base classes
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
        /**
hgs
parents:
diff changeset
   101
        * From ?base_class ?member_description
hgs
parents:
diff changeset
   102
        */
hgs
parents:
diff changeset
   103
        //?type ?member_function();
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
    private:
hgs
parents:
diff changeset
   106
hgs
parents:
diff changeset
   107
        /**
hgs
parents:
diff changeset
   108
        * C++ default constructor.
hgs
parents:
diff changeset
   109
        */
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
   110
        CUSBUiNotifApiTest( CTestModuleIf& aTestModuleIf );
44
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
        /**
hgs
parents:
diff changeset
   113
        * By default Symbian 2nd phase constructor is private.
hgs
parents:
diff changeset
   114
        */
hgs
parents:
diff changeset
   115
        void ConstructL();
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
        /**
hgs
parents:
diff changeset
   118
        * Frees all resources allocated from test methods.
hgs
parents:
diff changeset
   119
        * @since ?Series60_version
hgs
parents:
diff changeset
   120
        */
hgs
parents:
diff changeset
   121
        void Delete();
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
        /**
hgs
parents:
diff changeset
   124
        * Test methods are listed below. 
hgs
parents:
diff changeset
   125
        */
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
   126
        virtual TInt CableConnectedNotifierTest( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   127
        virtual TInt FinishCableConnectedQuery( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   128
        virtual TInt UsbQueriesNotifierTest( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   129
        virtual TInt UsbOTGErrorNotifierTests( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   130
        virtual TInt UsbOTGWarningNotifierTests( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   131
        virtual TInt FinishQuery( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   132
        virtual TInt LoadNotifiersL( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   133
        virtual TInt UnLoadNotifiers ( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   134
        virtual TInt UsbMSMMNotifierTests ( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   135
        virtual TInt CancelMsmmNotifier( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   136
        virtual TInt CancelQueryNotifier( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   137
        virtual TInt CancelOtgErrorNotifier( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   138
        virtual TInt CancelOtgWarningNotifier( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   139
        virtual TInt CancelCableConnectedNotifier( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   140
        virtual TInt WaitForRequest( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   141
        virtual TInt SynchStart( CStifItemParser& aItem );
831068540b07 201019_1
hgs
parents: 46
diff changeset
   142
        virtual TInt Update( CStifItemParser& aItem );
44
hgs
parents:
diff changeset
   143
        /**
hgs
parents:
diff changeset
   144
         * Method used to log version of test class
hgs
parents:
diff changeset
   145
         */
hgs
parents:
diff changeset
   146
        void SendTestClassVersion();
hgs
parents:
diff changeset
   147
hgs
parents:
diff changeset
   148
        //ADD NEW METHOD DEC HERE
hgs
parents:
diff changeset
   149
        //[TestMethods] - Do not remove
hgs
parents:
diff changeset
   150
        TInt GetTestOption( TPtrC aOptionString, TTestOption& aOption );
hgs
parents:
diff changeset
   151
        TInt GetPersonalityIdFromString( TPtrC aOptionString, TInt& aPersonalityId );
hgs
parents:
diff changeset
   152
        TInt GetQueryType( TPtrC aTypeString, TUSBUIQueries& aQueryType );        
hgs
parents:
diff changeset
   153
        TInt GetOTGErrorType( TPtrC aTypeString, TUsbUiNotifOtgError& aQueryType );
hgs
parents:
diff changeset
   154
        TInt GetOTGWarningType( TPtrC aTypeString, TUsbUiNotifOtgWarning& aQueryType );
hgs
parents:
diff changeset
   155
        TInt GetMSMMrrorType( TPtrC aTypeString, THostMsErrCode& aQueryType );
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
   156
        TInt FindAndKillProcess(const TDesC& aProcessName);
44
hgs
parents:
diff changeset
   157
hgs
parents:
diff changeset
   158
    public:     // Data
hgs
parents:
diff changeset
   159
hgs
parents:
diff changeset
   160
    protected:  // Data
hgs
parents:
diff changeset
   161
hgs
parents:
diff changeset
   162
    private:    // Data
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
   163
        
44
hgs
parents:
diff changeset
   164
        RNotifier *iNotifier;
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
   165
        TBool iNotifierConnected;
44
hgs
parents:
diff changeset
   166
        RUsbWatcher* iUsbWatcher;
hgs
parents:
diff changeset
   167
 
hgs
parents:
diff changeset
   168
        CRepository* iRepository;
hgs
parents:
diff changeset
   169
        
hgs
parents:
diff changeset
   170
        TUSBConnectionNotifierParamsPckg iConnectionNotifierResponseParamsPckg;
hgs
parents:
diff changeset
   171
        TRequestStatus iReqStatus;
hgs
parents:
diff changeset
   172
        TInt iPersonalityIdBackup;
hgs
parents:
diff changeset
   173
        TBool iCompleteQuery;        
hgs
parents:
diff changeset
   174
        TPckg<TInt> iRes;
hgs
parents:
diff changeset
   175
        CArrayPtr<MEikSrvNotifierBase2>* iNotifierArray;
hgs
parents:
diff changeset
   176
        TUid iInstanceUid;
hgs
parents:
diff changeset
   177
        THostMsErrData iErrData;
hgs
parents:
diff changeset
   178
        THostMsErrorDataPckg iErrPckg ;
hgs
parents:
diff changeset
   179
hgs
parents:
diff changeset
   180
    public:     // Friend classes
hgs
parents:
diff changeset
   181
        //?friend_class_declaration;
hgs
parents:
diff changeset
   182
    protected:  // Friend classes
hgs
parents:
diff changeset
   183
        //?friend_class_declaration;
hgs
parents:
diff changeset
   184
    private:    // Friend classes
hgs
parents:
diff changeset
   185
        //?friend_class_declaration;
52
831068540b07 201019_1
hgs
parents: 46
diff changeset
   186
44
hgs
parents:
diff changeset
   187
    };
hgs
parents:
diff changeset
   188
hgs
parents:
diff changeset
   189
#endif      // USBUINOTIFAPITEST_H
hgs
parents:
diff changeset
   190
hgs
parents:
diff changeset
   191
// End of File