sapi_location/tsrc/dev/tlocationprovidertest/inc/tcomplugin.h
changeset 0 14df0fbfcc4e
equal deleted inserted replaced
-1:000000000000 0:14df0fbfcc4e
       
     1 /*
       
     2 * Copyright (c) 2002 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:   ?Description
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef TCOMPLUGIN_H
       
    22 #define TCOMPLUGIN_H
       
    23 
       
    24 //  INCLUDES
       
    25 #include <StifLogger.h>
       
    26 #include <TestScripterInternal.h>
       
    27 #include <StifTestModule.h>
       
    28 
       
    29 #include "serviceerrno.h"
       
    30 
       
    31 // CONSTANTS
       
    32 //const ?type ?constant_var = ?constant;
       
    33 
       
    34 // MACROS
       
    35 //#define ?macro ?macro_def
       
    36 // Logging path
       
    37 _LIT( KTcompluginLogPath, "\\logs\\testframework\\Tcomplugin\\" ); 
       
    38 // Log file
       
    39 _LIT( KTcompluginLogFile, "Tcomplugin.txt" ); 
       
    40 
       
    41 _LIT8(KLocationContents , "Service.Location");
       
    42  _LIT8(KLocationInterface , "ILocation") ;
       
    43  _LIT8(KDataSource , "ILocation") ;
       
    44 _LIT8(KGetLocation , "GetLocation") ;
       
    45 _LIT8(KTraceLocation ,"Trace") ;
       
    46 _LIT8(KErrCode , "ErrorCode") ; 
       
    47 _LIT8(KService , "Service.Location") ;
       
    48 _LIT8(KContents , "ILocation") ;
       
    49 _LIT8( KCancelType , "CancelRequestType") ;
       
    50 _LIT8(KLsInterfaceName , "ILocation") ; 
       
    51 
       
    52 
       
    53 /**
       
    54  * Error Indntifier in Output parameter list
       
    55  */
       
    56  _LIT8(KErrorCode , "ErrorCode") ; 
       
    57  
       
    58  /**
       
    59   * Location SAPI result parmater identifiers
       
    60   */
       
    61  _LIT8(KLocationMap , "ReturnValue") ; 
       
    62  
       
    63  /**
       
    64  * Key for locating location information in CLiwGenericParamList
       
    65  */
       
    66 _LIT8(KLongitudeKey,"Longitude") ;
       
    67 _LIT8(KLatitudeKey , "Latitude") ;
       
    68 _LIT8(KAltitudeKey , "Altitude") ;
       
    69 
       
    70 
       
    71 
       
    72 /**
       
    73  * Various command for Location service
       
    74  */
       
    75  
       
    76 _LIT8( KCmdGetLocation , "GetLocation" ) ;
       
    77 _LIT8( KCmdTraceLocation, "Trace" ) ;
       
    78 _LIT8( KCmdCancelRequest, "CancelNotification" ) ;
       
    79 
       
    80 _LIT8( KRequestTrace ,"TraceCancel") ;
       
    81 _LIT8( KRequestGetLoc , "GetLocCancel" ) ;
       
    82 _LIT8( KRequestCalculate , "Calculate") ;
       
    83 
       
    84 
       
    85 /**
       
    86  * Update Options
       
    87  */
       
    88 _LIT8(KUpdateOptionMap,"Updateoptions");
       
    89 _LIT8(KUpdateOptionInterval,"UpdateInterval");
       
    90 _LIT8(KUpdateOptionTimeOut,"UpdateTimeOut");
       
    91 _LIT8(KUpdateOptionMaxAge,"UpdateMaxAge");
       
    92 _LIT8(KPartialUpdates , "PartialUpdates");
       
    93 
       
    94 /**
       
    95  * Math operations request identifiers 
       
    96  */
       
    97 _LIT( KRequestDistance , "FindDistance") ;
       
    98 _LIT(KRequestBearingTo,"FindBearingTo");
       
    99 _LIT(KRequestMove,"MoveCoordinates");
       
   100 _LIT8(KDistanceParmSource , "DistanceParamSource") ;
       
   101 _LIT8(KDistanceMove , "MoveByThisDistance");
       
   102 _LIT8(KBearingMove , "MoveByThisBearing");
       
   103 _LIT8(KDistanceParmDestination , "DistanceParamDestination") ;
       
   104 _LIT8(KMathOpResult,"ReturnValue");
       
   105 _LIT8(	KMathRequest , "MathRequest") ;
       
   106 
       
   107 
       
   108 /**
       
   109  * Class of Location Information ;user is 
       
   110  * looking for
       
   111  */
       
   112 _LIT8(KLocationInfoCategory,"LocationInformationClass");
       
   113 _LIT8(KLocationBasicinfo,"BasicLocationInformation");
       
   114 _LIT8(KLocationGenericInfo,"GenericLocationInfo");
       
   115 
       
   116 
       
   117 class CTestProvider;
       
   118 
       
   119 
       
   120 /**
       
   121 *  CTestProvider test class for STIF Test Framework TestScripter.
       
   122 *  ?other_description_lines
       
   123 *
       
   124 *  @lib ?library
       
   125 *  @since ?Series60_version
       
   126 */
       
   127 NONSHARABLE_CLASS(CTestProvider) : public CScriptBase
       
   128     {
       
   129     public:  // Constructors and destructor
       
   130 
       
   131         /**
       
   132         * Two-phased constructor.
       
   133         */
       
   134         static CTestProvider* NewL( CTestModuleIf& aTestModuleIf );
       
   135 
       
   136         /**
       
   137         * Destructor.
       
   138         */
       
   139         virtual ~CTestProvider();
       
   140 
       
   141     public: // New functions
       
   142 
       
   143         /**
       
   144         * ?member_description.
       
   145         * @since ?Series60_version
       
   146         * @param ?arg1 ?description
       
   147         * @return ?description
       
   148         */
       
   149         //?type ?member_function( ?type ?arg1 );
       
   150 
       
   151     public: // Functions from base classes
       
   152 
       
   153         /**
       
   154         * From CScriptBase Runs a script line.
       
   155         * @since ?Series60_version
       
   156         * @param aItem Script line containing method name and parameters
       
   157         * @return Symbian OS error code
       
   158         */
       
   159         virtual TInt RunMethodL( CStifItemParser& aItem );
       
   160 
       
   161     protected:  // New functions
       
   162 
       
   163         /**
       
   164         * ?member_description.
       
   165         * @since ?Series60_version
       
   166         * @param ?arg1 ?description
       
   167         * @return ?description
       
   168         */
       
   169         //?type ?member_function( ?type ?arg1 );
       
   170 
       
   171     protected:  // Functions from base classes
       
   172 
       
   173         /**
       
   174         * From ?base_class ?member_description
       
   175         */
       
   176         //?type ?member_function();
       
   177 
       
   178     private:
       
   179 
       
   180         /**
       
   181         * C++ default constructor.
       
   182         */
       
   183         CTestProvider( CTestModuleIf& aTestModuleIf );
       
   184         
       
   185 
       
   186         /**
       
   187         * By default Symbian 2nd phase constructor is private.
       
   188         */
       
   189         void ConstructL();
       
   190 
       
   191         // Prohibit copy constructor if not deriving from CBase.
       
   192         // ?classname( const ?classname& );
       
   193         // Prohibit assigment operator if not deriving from CBase.
       
   194         // ?classname& operator=( const ?classname& );
       
   195 
       
   196         /**
       
   197         * Frees all resources allocated from test methods.
       
   198         * @since ?Series60_version
       
   199         */
       
   200         void Delete();
       
   201 
       
   202         /**
       
   203         * Test methods are listed below. 
       
   204         */
       
   205 
       
   206         /**
       
   207         * Example test method.
       
   208         * @since ?Series60_version
       
   209         * @param aItem Script line containing parameters.
       
   210         * @return Symbian OS error code.
       
   211         */
       
   212         virtual TInt GetLocation(CStifItemParser &aItem );
       
   213         virtual TInt LocationUpdates(CStifItemParser& aItem) ;
       
   214         virtual TInt GetLocationAsynch(CStifItemParser& aItem) ;
       
   215         virtual TInt ServiceFailed(CStifItemParser& aItem) ;
       
   216         virtual TInt ServiceNotAvailable(CStifItemParser& aItem) ;
       
   217         virtual TInt StraySignal(CStifItemParser& aItem) ;
       
   218 		virtual TInt StraySignalGetLoc(CStifItemParser& aItem) ;
       
   219 		virtual TInt ConcurrentCallsGetLoc(CStifItemParser& aItem);
       
   220 		virtual TInt ConcurrentCallsTrace(CStifItemParser& aItem);
       
   221 		virtual TInt EmptyCancelTraceTest(CStifItemParser& aItem);
       
   222 		virtual TInt EmptyCancelGetLocTest(CStifItemParser& aItem);
       
   223 		virtual TInt CancelWrongNotification1(CStifItemParser& aItem);
       
   224 		virtual TInt CancelWrongNotification2(CStifItemParser& /*aItem*/) ;
       
   225 		virtual TInt GetLocationCancel(CStifItemParser& /*aItem*/) ;
       
   226 		virtual TInt TraceLocationCancel(CStifItemParser& /*aItem*/) ;
       
   227 		virtual TInt GetLocationTimedOut(CStifItemParser& /*aItem*/) ;
       
   228 		virtual TInt BearingToTest(CStifItemParser& /*aItem*/) ;
       
   229 		virtual TInt FindDistance(CStifItemParser& /*aItem*/) ;
       
   230 		virtual TInt FindDistanceAgain(CStifItemParser& /*aItem*/) ;
       
   231 		virtual TInt GetLocationUpdateOpts(CStifItemParser& /*aItem*/) ;
       
   232         virtual TInt MoveCoordinates(CStifItemParser& /*aItem*/) ;
       
   233         
       
   234         virtual TInt GetLocationSynchWrongUpdateMapType(CStifItemParser& /*aItem*/) ;
       
   235         virtual TInt CancelWithInvalidTransId(CStifItemParser& /*aItem*/) ;
       
   236         virtual TInt getlocationPostionbased(CStifItemParser& /*aItem*/) ;
       
   237         virtual TInt getlocationPostionbasedwithupdateoption(CStifItemParser& /*aItem*/) ;
       
   238     	virtual TInt getlocationPostionbasedpdateoption(CStifItemParser& /*aItem*/) ;
       
   239     	virtual TInt GetLocationWrongInfoClass(CStifItemParser& /*aItem*/) ;
       
   240     	virtual TInt TraceWrongInfoClass(CStifItemParser& /*aItem*/) ;
       
   241     	virtual TInt GetLocNegativeUpdateoption(CStifItemParser& /*aItem*/) ;
       
   242     	virtual TInt TraceNegativeUpdateoption(CStifItemParser& /*aItem*/) ;
       
   243     	virtual TInt TestWrongInterfaceName(CStifItemParser& /*aItem*/) ;
       
   244     	virtual TInt TestAllApi(CStifItemParser& /*aItem*/) ;
       
   245     	virtual TInt CancelTwice(CStifItemParser& /*aItem*/) ;
       
   246     public:     // Data
       
   247         // ?one_line_short_description_of_data
       
   248         //?data_declaration;
       
   249 
       
   250     protected:  // Data
       
   251         // ?one_line_short_description_of_data
       
   252         //?data_declaration;
       
   253 
       
   254     private:    // Data
       
   255         
       
   256         // ?one_line_short_description_of_data
       
   257         //?data_declaration;
       
   258         TInt CTestGetLocation() ;
       
   259 
       
   260         // Reserved pointer for future extension
       
   261         //TAny* iReserved;
       
   262 
       
   263     public:     // Friend classes
       
   264         //?friend_class_declaration;
       
   265     protected:  // Friend classes
       
   266         //?friend_class_declaration;
       
   267     private:    // Friend classes
       
   268         //?friend_class_declaration;
       
   269 
       
   270     };
       
   271     TInt GetLocUpdates(TAny *aPtr);
       
   272     TInt FindLocationAsynch(TAny *aPtr);
       
   273     TInt ServiceFailedTest(TAny *Arg) ;
       
   274     TInt StrayTest(TAny *aArg) ;
       
   275     TInt ConcurrentGetLocationCalls(TAny *aArg) ;
       
   276 
       
   277     TInt StrayTestGetLoc(TAny *aArg) ;
       
   278     TInt TraceConcurrent(TAny */*Arg*/);
       
   279     TInt GetLocWrongCancel(TAny */*Arg*/);
       
   280     TInt TraceLocWrongCancel(TAny */*Arg*/);
       
   281     TInt GetLocCancel(TAny */*Arg*/);
       
   282     TInt TraceLocCancel(TAny */*Arg*/);
       
   283     
       
   284 
       
   285 
       
   286 #endif      // TCOMPLUGIN_H
       
   287 
       
   288 // End of File