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 the License "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 

    19 #ifndef MESSAGEQUEUE_API_H

    20 #define MESSAGEQUEUE_API_H

    21 

    22 //  INCLUDES

    23 #include <StifLogger.h>

    24 #include <TestScripterInternal.h>

    25 #include <StifTestModule.h>

    26 #include <TestclassAssert.h>

    27 

    28 

    29 // CONSTANTS

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

    31 

    32 // MACROS

    33 //#define ?macro ?macro_def

    34 #define TEST_CLASS_VERSION_MAJOR 0

    35 #define TEST_CLASS_VERSION_MINOR 0

    36 #define TEST_CLASS_VERSION_BUILD 0

    37 

    38 // Logging path

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

    40 // Log file

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

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

    43 

    44 // FUNCTION PROTOTYPES

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

    46 

    47 // FORWARD DECLARATIONS

    48 //class ?FORWARD_CLASSNAME;

    49 class Cmessagequeue_api;

    50 

    51 // DATA TYPES

    52 //enum ?declaration

    53 //typedef ?declaration

    54 //extern ?data_type;

    55 

    56 // CLASS DECLARATION

    57 

    58 /**

    59 *  Cmessagequeue_api test class for STIF Test Framework TestScripter.

    60 *  ?other_description_lines

    61 *

    62 *  @lib ?library

    63 *  @since ?Series60_version

    64 */

    65 NONSHARABLE_CLASS(Cmessagequeue_api) : public CScriptBase

    66     {

    67     public:  // Constructors and destructor

    68 

    69         /**

    70         * Two-phased constructor.

    71         */

    72         static Cmessagequeue_api* NewL( CTestModuleIf& aTestModuleIf );

    73 

    74         /**

    75         * Destructor.

    76         */

    77         virtual ~Cmessagequeue_api();

    78 

    79     public: // New functions

    80 

    81         /**

    82         * ?member_description.

    83         * @since ?Series60_version

    84         * @param ?arg1 ?description

    85         * @return ?description

    86         */

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

    88 

    89     public: // Functions from base classes

    90 

    91         /**

    92         * From CScriptBase Runs a script line.

    93         * @since ?Series60_version

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

    95         * @return Symbian OS error code

    96         */

    97         virtual TInt RunMethodL( CStifItemParser& aItem );

    98 

    99     protected:  // New functions

   100 

   101         /**

   102         * ?member_description.

   103         * @since ?Series60_version

   104         * @param ?arg1 ?description

   105         * @return ?description

   106         */

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

   108 

   109     protected:  // Functions from base classes

   110 

   111         /**

   112         * From ?base_class ?member_description

   113         */

   114         //?type ?member_function();

   115 

   116     private:

   117 

   118         /**

   119         * C++ default constructor.

   120         */

   121         Cmessagequeue_api( CTestModuleIf& aTestModuleIf );

   122 

   123         /**

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

   125         */

   126         void ConstructL();

   127 

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

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

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

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

   132 

   133         /**

   134         * Frees all resources allocated from test methods.

   135         * @since ?Series60_version

   136         */

   137         void Delete();

   138 

   139         /**

   140         * Test methods are listed below. 

   141         */

   142 

   143         /**

   144         * Example test method.

   145         * @since ?Series60_version

   146         * @param aItem Script line containing parameters.

   147         * @return Symbian OS error code.

   148         */

   149         virtual TInt TestMessageQCreate( CStifItemParser& aItem );

   150         virtual TInt TestMessageQSend( CStifItemParser& aItem );

   151         virtual TInt TestMessageQDelete( CStifItemParser& aItem ); 

   152         virtual TInt TestMessageQReceive(CStifItemParser& aItem );

   153         virtual TInt TestMessageQClean(CStifItemParser& aItem );

   154         virtual TInt TestMessageQCheck(CStifItemParser& aItem );

   155         virtual TInt TestMsgQMaxCheck(CStifItemParser& aItem );

   156 

   157         

   158         /**

   159          * Method used to log version of test class

   160          */

   161         void SendTestClassVersion();

   162 

   163         //ADD NEW METHOD DEC HERE

   164         //[TestMethods] - Do not remove

   165 

   166     public:     // Data

   167         // ?one_line_short_description_of_data

   168         //?data_declaration;

   169 

   170     protected:  // Data

   171         // ?one_line_short_description_of_data

   172         //?data_declaration;

   173 

   174     private:    // Data

   175         

   176         // ?one_line_short_description_of_data

   177         //?data_declaration;

   178 

   179         // Reserved pointer for future extension

   180         //TAny* iReserved;

   181 

   182     public:     // Friend classes

   183         //?friend_class_declaration;

   184     protected:  // Friend classes

   185         //?friend_class_declaration;

   186     private:    // Friend classes

   187         //?friend_class_declaration;

   188 

   189     };

   190 

   191 #endif      // MESSAGEQUEUE_API_H

   192 

   193 // End of File