stif/TestCombiner/inc/TestKeywords.h
branchRCL_3
changeset 59 8ad140f3dd41
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/stif/TestCombiner/inc/TestKeywords.h	Wed Oct 13 16:17:58 2010 +0300
@@ -0,0 +1,186 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+* 
+* Description: This file contains the keywords for the TestCombiner 
+* module.
+*
+*/
+
+#ifndef TESTKEYWORDS_H
+#define TESTKEYWORDS_H
+
+//  INCLUDES
+#include <e32base.h>
+#include <StifTestInterface.h>
+
+// CONSTANTS
+// None
+
+// MACROS
+// None
+
+// DATA TYPES
+typedef TPtrC (*KeywordFunc)( TInt aKeyword );
+
+// FUNCTION PROTOTYPES
+// None
+
+// FORWARD DECLARATIONS
+// None
+
+// CLASS DECLARATION
+
+// DESCRIPTION
+// Test Combiner Keyword class
+class TTCKeywords 
+    {
+    public: // Enumerations
+        // Keyword enum
+        enum TKeywords
+            {
+            ETitle,
+            ERun,
+            ECancel,
+            EPause,
+            EResume,
+            EComplete,
+            ERequest,
+            EWait,
+            ERelease,
+            ESet,
+            EUnset,
+            ETimeout,
+            EPriority,
+            EPrint,
+            EAllocate,
+            EFree,
+            ERemote,
+            ESendReceive,
+            ECancelIfError,
+            EMeasurement,
+            ELoop,
+            EEndLoop,
+            EPauseCombiner,  
+            };
+
+        // run keyword optional arguments
+        enum TRunOptArgs
+            {
+            EExpect,
+            ETestid,
+            EIni,
+            ECategory,
+            ECaseTimeout,
+            ECaseTitle,
+            EArgs,			
+            };
+
+        // pause keyword optional arguments
+        enum TPauseOptArgs
+            {
+            ETime,
+            };
+
+        // event keywords optional arguments
+        enum TEventOptArgs
+            {
+            EState,
+            };
+
+        // priorities
+        enum TPriority
+            {
+            EPriHigh,
+            EPriNormal,
+            EPriLow,
+            };
+
+    private: // Enumerations
+
+    public: // Constructors and destructor
+
+    public: // Constructors and destructor
+
+    public: // New functions
+
+        /**
+        * Returns a string desrciptor corresponding to keyword number. 
+        */
+        static TPtrC Keyword( TInt aKeyword );
+
+        /**
+        * Returns a string desrciptor corresponding to run keyword 
+        * optional argument number. 
+        */
+        static TPtrC RunOptArg( TInt aArg );
+
+        /**
+        * Returns a string desrciptor corresponding to pause keyword 
+        * optional argument number. 
+        */
+        static TPtrC PauseOptArg( TInt aArg );
+
+        /**
+        * Returns a string desrciptor corresponding to event keywords 
+        * optional argument number. 
+        */
+        static TPtrC EventOptArg( TInt aArg );
+
+        /**
+        * Returns a string desrciptor corresponding to priority 
+        * enum value. 
+        */
+        static TPtrC Priority( TInt aArg );
+
+        /**
+        * Returns a keyword enum corresponding to keyword 
+        * string descriptor. 
+        */
+        static TInt Parse( TDesC& aKeyword, KeywordFunc aFunc );
+
+        /**
+        * Returns result category description. 
+        */
+        static TPtrC ResultCategory( TInt aArg );
+
+        /**
+        * Returns result category type. 
+        */
+        static TFullTestResult::TCaseExecutionResult 
+            GetResultCategory( TDesC& aCategory );
+
+    public: // Functions from base classes
+
+    protected:  // New functions
+
+    protected:  // Functions from base classes
+
+    private:    // New functions
+
+    public:     // Data
+     
+    protected:  // Data
+
+    private:    // Data
+
+    public:     // Friend classes
+
+    protected:  // Friend classes
+
+    private:    // Friend classes
+
+    };
+
+#endif        // TESTKEYWORDS_H  
+
+// End of File