uiservicetab/vimpstengine/inc/cvimpstenginerequest.h
changeset 15 81eeb8c83ce5
parent 0 5e5d6b214f4f
equal deleted inserted replaced
0:5e5d6b214f4f 15:81eeb8c83ce5
     1 /*
       
     2 * Copyright (c) 2008 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: implements the request handler for ximp fw.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef _CVIMPSTENGINEREQUEST_H__
       
    21 #define _CVIMPSTENGINEREQUEST_H__
       
    22 
       
    23 // include files
       
    24 #include <e32base.h>
       
    25 #include <ximpbase.h>
       
    26 #include "tvimpstenums.h"
       
    27 
       
    28 /**
       
    29  *  This class implements the request handler for ximp fw.
       
    30  *
       
    31  *  @lib vimpstengine.lib
       
    32  *  @since S60 5.0
       
    33  */
       
    34 NONSHARABLE_CLASS(CVIMPSTEngineRequest) :public CBase
       
    35 	{
       
    36 
       
    37 	public:  // Two-phased constructors and destructor
       
    38 
       
    39        /**
       
    40 		* Two-phased constructor.
       
    41 		* @param aRequestId request id
       
    42 		* @param aRequestType - Enum defined in tvimpstenums.h
       
    43 		*/
       
    44 		static CVIMPSTEngineRequest* NewL(TXIMPRequestId& aRequestId,
       
    45 		        TXimpOperation aRequestType );
       
    46 
       
    47 
       
    48        /**
       
    49 		* Two-phased constructor.
       
    50 		* @param aRequestId request id
       
    51 		*/
       
    52 		static CVIMPSTEngineRequest* NewLC(TXIMPRequestId& aRequestId,
       
    53 		        TXimpOperation aRequestType);
       
    54 
       
    55 		/**
       
    56 		* ~CVIMPSTEngineRequest 
       
    57 		*/
       
    58 		virtual ~CVIMPSTEngineRequest();
       
    59 
       
    60 		/**
       
    61 		* StartWait
       
    62 		*/
       
    63 		void StartWait();
       
    64 
       
    65 		/**
       
    66 		* StopWait method 
       
    67 		*/
       
    68 		void StopWait();
       
    69 
       
    70 		/**
       
    71 		* GetRequestId  
       
    72 		* @return TXIMPRequestId the request id 
       
    73 		*/
       
    74 		const TXIMPRequestId& GetRequestId() const;
       
    75 
       
    76 		/**
       
    77 		* IsWaitStarted method from context obsrver  
       
    78 		* check weather wait is started or not
       
    79 		* @return TBool ETrue if wait is started, else EFalse.
       
    80 		*/
       
    81 		TBool IsWaitStarted() ;		
       
    82 		
       
    83 		/**
       
    84          * Set the Type of Request
       
    85          * @param aType, a request type - Enum defined in tvimpstenums.h
       
    86          */
       
    87         void SetRequestType(TXimpOperation aType) ;
       
    88         
       
    89         
       
    90         /**
       
    91          * Get the Type of Request
       
    92          * @return request type - Enum defined in tvimpstenums.h
       
    93          */
       
    94         TXimpOperation RequestType() const;
       
    95 	
       
    96 	private:
       
    97 
       
    98 
       
    99 		/**
       
   100 		* CVIMPSTEngineRequest 
       
   101 		* @ param aRequestId ,request id 
       
   102 		* @ param aType, request type.
       
   103 		*/
       
   104 		CVIMPSTEngineRequest(TXIMPRequestId& aRequestId,
       
   105 		        TXimpOperation aRequestType);
       
   106 
       
   107 	private:
       
   108 		// own request id
       
   109 		TXIMPRequestId  iRequestId;
       
   110 
       
   111 		// own active sheduler 
       
   112 		CActiveSchedulerWait    iWait;
       
   113 		
       
   114 		//request type
       
   115 		TXimpOperation iReqType ;
       
   116 		
       
   117 };
       
   118 
       
   119 #endif  //_CVIMPSTENGINEREQUEST_H__
       
   120 
       
   121 // end of file