gstreamer_core/tsrc/gstreamertestcases/inc/GstreamerTestCases.h
branchRCL_3
changeset 30 7e817e7e631c
parent 29 567bb019e3e3
equal deleted inserted replaced
29:567bb019e3e3 30:7e817e7e631c
     1 /*
       
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
       
     3 *
       
     4 * This library is free software; you can redistribute it and/or
       
     5 * modify it under the terms of the GNU Lesser General Public
       
     6 * License as published by the Free Software Foundation; either
       
     7 * version 2 of the License, or (at your option) any later version.
       
     8 *
       
     9 * This library is distributed in the hope that it will be useful,
       
    10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
       
    12 * Lesser General Public License for more details.
       
    13 *
       
    14 * You should have received a copy of the GNU Lesser General Public
       
    15 * License along with this library; if not, write to the
       
    16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
       
    17 * Boston, MA 02111-1307, USA.
       
    18 *
       
    19 * Description: STIF testclass declaration
       
    20 *
       
    21 */
       
    22 
       
    23 
       
    24 #ifndef GSTREAMERTESTCASES_H
       
    25 #define GSTREAMERTESTCASES_H
       
    26 
       
    27 //  INCLUDES
       
    28 #include <StifLogger.h>
       
    29 #include <TestScripterInternal.h>
       
    30 #include <StifTestModule.h>
       
    31 #include <TestclassAssert.h>
       
    32 
       
    33 // CONSTANTS
       
    34 //const ?type ?constant_var = ?constant;
       
    35 
       
    36 // MACROS
       
    37 //#define ?macro ?macro_def
       
    38 #define TEST_CLASS_VERSION_MAJOR 0
       
    39 #define TEST_CLASS_VERSION_MINOR 0
       
    40 #define TEST_CLASS_VERSION_BUILD 0
       
    41 
       
    42 // Logging path
       
    43 _LIT( KGstreamerTestCasesLogPath, "\\logs\\testframework\\GstreamerTestCases\\" ); 
       
    44 // Log file
       
    45 _LIT( KGstreamerTestCasesLogFile, "GstreamerTestCases.htm" ); 
       
    46 _LIT( KGstreamerTestCasesLogFileWithTitle, "GstreamerTestCases_[%S].htm" );
       
    47 
       
    48 // FUNCTION PROTOTYPES
       
    49 //?type ?function_name(?arg_list);
       
    50 
       
    51 // FORWARD DECLARATIONS
       
    52 //class ?FORWARD_CLASSNAME;
       
    53 class CGstreamerTestCases;
       
    54 
       
    55 // DATA TYPES
       
    56 //enum ?declaration
       
    57 //typedef ?declaration
       
    58 //extern ?data_type;
       
    59 
       
    60 // CLASS DECLARATION
       
    61 
       
    62 /**
       
    63 *  CGstreamerTestCases test class for STIF Test Framework TestScripter.
       
    64 *  ?other_description_lines
       
    65 *
       
    66 *  @lib ?library
       
    67 *  @since ?Series60_version
       
    68 */
       
    69 NONSHARABLE_CLASS(CGstreamerTestCases) : public CScriptBase
       
    70     {
       
    71     public:  // Constructors and destructor
       
    72 
       
    73         /**
       
    74         * Two-phased constructor.
       
    75         */
       
    76         static CGstreamerTestCases* NewL( CTestModuleIf& aTestModuleIf );
       
    77 
       
    78         /**
       
    79         * Destructor.
       
    80         */
       
    81         virtual ~CGstreamerTestCases();
       
    82 
       
    83     public: // New functions
       
    84 
       
    85         /**
       
    86         * ?member_description.
       
    87         * @since ?Series60_version
       
    88         * @param ?arg1 ?description
       
    89         * @return ?description
       
    90         */
       
    91         //?type ?member_function( ?type ?arg1 );
       
    92 
       
    93     public: // Functions from base classes
       
    94 
       
    95         /**
       
    96         * From CScriptBase Runs a script line.
       
    97         * @since ?Series60_version
       
    98         * @param aItem Script line containing method name and parameters
       
    99         * @return Symbian OS error code
       
   100         */
       
   101         virtual TInt RunMethodL( CStifItemParser& aItem );
       
   102 
       
   103     protected:  // New functions
       
   104 
       
   105         /**
       
   106         * ?member_description.
       
   107         * @since ?Series60_version
       
   108         * @param ?arg1 ?description
       
   109         * @return ?description
       
   110         */
       
   111         //?type ?member_function( ?type ?arg1 );
       
   112 
       
   113     protected:  // Functions from base classes
       
   114 
       
   115         /**
       
   116         * From ?base_class ?member_description
       
   117         */
       
   118         //?type ?member_function();
       
   119 
       
   120     private:
       
   121 
       
   122         /**
       
   123         * C++ default constructor.
       
   124         */
       
   125         CGstreamerTestCases( CTestModuleIf& aTestModuleIf );
       
   126 
       
   127         /**
       
   128         * By default Symbian 2nd phase constructor is private.
       
   129         */
       
   130         void ConstructL();
       
   131 
       
   132         // Prohibit copy constructor if not deriving from CBase.
       
   133         // ?classname( const ?classname& );
       
   134         // Prohibit assigment operator if not deriving from CBase.
       
   135         // ?classname& operator=( const ?classname& );
       
   136 
       
   137         /**
       
   138         * Frees all resources allocated from test methods.
       
   139         * @since ?Series60_version
       
   140         */
       
   141         void Delete();
       
   142 
       
   143         /**
       
   144         * Test methods are listed below. 
       
   145         */
       
   146 
       
   147         /**
       
   148         * Example test method.
       
   149         * @since ?Series60_version
       
   150         * @param aItem Script line containing parameters.
       
   151         * @return Symbian OS error code.
       
   152         */
       
   153         virtual TInt ExampleL( CStifItemParser& aItem );
       
   154         
       
   155         /**
       
   156          * Method used to log version of test class
       
   157          */
       
   158         void SendTestClassVersion();
       
   159 
       
   160         //ADD NEW METHOD DEC HERE
       
   161         //[TestMethods] - Do not remove
       
   162 
       
   163     public:     // Data
       
   164         // ?one_line_short_description_of_data
       
   165         //?data_declaration;
       
   166 
       
   167     protected:  // Data
       
   168         // ?one_line_short_description_of_data
       
   169         //?data_declaration;
       
   170 
       
   171     private:    // Data
       
   172         
       
   173         // ?one_line_short_description_of_data
       
   174         //?data_declaration;
       
   175 
       
   176         // Reserved pointer for future extension
       
   177         //TAny* iReserved;
       
   178 
       
   179     public:     // Friend classes
       
   180         //?friend_class_declaration;
       
   181     protected:  // Friend classes
       
   182         //?friend_class_declaration;
       
   183     private:    // Friend classes
       
   184         //?friend_class_declaration;
       
   185 
       
   186     };
       
   187 
       
   188 #endif      // GSTREAMERTESTCASES_H
       
   189 
       
   190 // End of File