1 /*

     2 * Copyright (c) 2009 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: STIF testclass declaration

    15 *

    16 */

    17 

    18 #ifndef MESSAGEQUEUE_API_H

    19 #define MESSAGEQUEUE_API_H

    20 

    21 //  INCLUDES

    22 #include <StifLogger.h>

    23 #include <TestScripterInternal.h>

    24 #include <StifTestModule.h>

    25 #include <TestclassAssert.h>

    26 

    27 

    28 // CONSTANTS

    29 //const ?type ?constant_var = ?constant;

    30 

    31 // MACROS

    32 //#define ?macro ?macro_def

    33 #define TEST_CLASS_VERSION_MAJOR 0

    34 #define TEST_CLASS_VERSION_MINOR 0

    35 #define TEST_CLASS_VERSION_BUILD 0

    36 

    37 // Logging path

    38 _LIT( Kmessagequeue_apiLogPath, "\\logs\\testframework\\messagequeue_api\\" ); 

    39 // Log file

    40 _LIT( Kmessagequeue_apiLogFile, "messagequeue_api.txt" ); 

    41 _LIT( Kmessagequeue_apiLogFileWithTitle, "messagequeue_api_[%S].txt" );

    42 

    43 // FUNCTION PROTOTYPES

    44 //?type ?function_name(?arg_list);

    45 

    46 // FORWARD DECLARATIONS

    47 //class ?FORWARD_CLASSNAME;

    48 class Cmessagequeue_api;

    49 

    50 // DATA TYPES

    51 //enum ?declaration

    52 //typedef ?declaration

    53 //extern ?data_type;

    54 

    55 // CLASS DECLARATION

    56 

    57 /**

    58 *  Cmessagequeue_api test class for STIF Test Framework TestScripter.

    59 *  ?other_description_lines

    60 *

    61 *  @lib ?library

    62 *  @since ?Series60_version

    63 */

    64 NONSHARABLE_CLASS(Cmessagequeue_api) : public CScriptBase

    65     {

    66     public:  // Constructors and destructor

    67 

    68         /**

    69         * Two-phased constructor.

    70         */

    71         static Cmessagequeue_api* NewL( CTestModuleIf& aTestModuleIf );

    72 

    73         /**

    74         * Destructor.

    75         */

    76         virtual ~Cmessagequeue_api();

    77 

    78     public: // New functions

    79 

    80         /**

    81         * ?member_description.

    82         * @since ?Series60_version

    83         * @param ?arg1 ?description

    84         * @return ?description

    85         */

    86         //?type ?member_function( ?type ?arg1 );

    87 

    88     public: // Functions from base classes

    89 

    90         /**

    91         * From CScriptBase Runs a script line.

    92         * @since ?Series60_version

    93         * @param aItem Script line containing method name and parameters

    94         * @return Symbian OS error code

    95         */

    96         virtual TInt RunMethodL( CStifItemParser& aItem );

    97 

    98     protected:  // New functions

    99 

   100         /**

   101         * ?member_description.

   102         * @since ?Series60_version

   103         * @param ?arg1 ?description

   104         * @return ?description

   105         */

   106         //?type ?member_function( ?type ?arg1 );

   107 

   108     protected:  // Functions from base classes

   109 

   110         /**

   111         * From ?base_class ?member_description

   112         */

   113         //?type ?member_function();

   114 

   115     private:

   116 

   117         /**

   118         * C++ default constructor.

   119         */

   120         Cmessagequeue_api( CTestModuleIf& aTestModuleIf );

   121 

   122         /**

   123         * By default Symbian 2nd phase constructor is private.

   124         */

   125         void ConstructL();

   126 

   127         // Prohibit copy constructor if not deriving from CBase.

   128         // ?classname( const ?classname& );

   129         // Prohibit assigment operator if not deriving from CBase.

   130         // ?classname& operator=( const ?classname& );

   131 

   132         /**

   133         * Frees all resources allocated from test methods.

   134         * @since ?Series60_version

   135         */

   136         void Delete();

   137 

   138         /**

   139         * Test methods are listed below. 

   140         */

   141 

   142         /**

   143         * Example test method.

   144         * @since ?Series60_version

   145         * @param aItem Script line containing parameters.

   146         * @return Symbian OS error code.

   147         */

   148         virtual TInt TestMessageQCreate( CStifItemParser& aItem );

   149         virtual TInt TestMessageQSend( CStifItemParser& aItem );

   150         virtual TInt TestMessageQDelete( CStifItemParser& aItem ); 

   151         virtual TInt TestMessageQReceive(CStifItemParser& aItem );

   152         virtual TInt TestMessageQClean(CStifItemParser& aItem );

   153         virtual TInt TestMessageQCheck(CStifItemParser& aItem );

   154         virtual TInt TestMsgQMaxCheck(CStifItemParser& aItem );

   155 

   156         

   157         /**

   158          * Method used to log version of test class

   159          */

   160         void SendTestClassVersion();

   161 

   162         //ADD NEW METHOD DEC HERE

   163         //[TestMethods] - Do not remove

   164 

   165     public:     // Data

   166         // ?one_line_short_description_of_data

   167         //?data_declaration;

   168 

   169     protected:  // Data

   170         // ?one_line_short_description_of_data

   171         //?data_declaration;

   172 

   173     private:    // Data

   174         

   175         // ?one_line_short_description_of_data

   176         //?data_declaration;

   177 

   178         // Reserved pointer for future extension

   179         //TAny* iReserved;

   180 

   181     public:     // Friend classes

   182         //?friend_class_declaration;

   183     protected:  // Friend classes

   184         //?friend_class_declaration;

   185     private:    // Friend classes

   186         //?friend_class_declaration;

   187 

   188     };

   189 

   190 #endif      // MESSAGEQUEUE_API_H

   191 

   192 // End of File