stif/TestEngine/inc/TestEngineEvent.h
branchRCL_3
changeset 59 8ad140f3dd41
equal deleted inserted replaced
49:7fdc9a71d314 59:8ad140f3dd41
       
     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: This file contains the header file of the event 
       
    15 * interface.
       
    16 *
       
    17 */
       
    18 
       
    19 #ifndef TESTENGINEEVENT_H
       
    20 #define TESTENGINEEVENT_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <StifTestEventInterface.h>
       
    24 
       
    25 // CONSTANTS
       
    26 // None
       
    27 
       
    28 // MACROS
       
    29 // None
       
    30 
       
    31 // DATA TYPES
       
    32 // None
       
    33 
       
    34 
       
    35 // FUNCTION PROTOTYPES
       
    36 // None
       
    37 
       
    38 
       
    39 // FORWARD DECLARATIONS
       
    40 // None
       
    41 
       
    42 
       
    43 // CLASS DECLARATION
       
    44 
       
    45 // DESCRIPTION
       
    46 // Interface class for the test system.
       
    47 class TEventMsg
       
    48     :public TEventIf
       
    49     {
       
    50     public:     // Enumerations
       
    51         // None
       
    52 
       
    53     private:    // Enumerations
       
    54         // None
       
    55 
       
    56     public:     // Constructors and destructor
       
    57         /**
       
    58         * C++ default constructor.
       
    59         */
       
    60         TEventMsg();
       
    61 
       
    62         /**
       
    63         * C++ destructor.
       
    64         */
       
    65         ~TEventMsg();
       
    66 
       
    67     public:     // New functions
       
    68         
       
    69         /**
       
    70         * Set event.
       
    71         */
       
    72         void Set( TEventType aEventType );
       
    73 
       
    74         /**
       
    75         * Wait event.
       
    76         */
       
    77         void Wait( const RMessage2& aMessage );
       
    78             
       
    79         /**
       
    80         * Cancel pending Wait.
       
    81         */
       
    82         void CancelWait();
       
    83              
       
    84         /**
       
    85         * Release event. Unset released.
       
    86         */
       
    87         void Release();
       
    88         
       
    89         /**
       
    90         * Unset event. Blocks until Release is called.
       
    91         */
       
    92         void Unset( TRequestStatus& aStatus );
       
    93         
       
    94     public:     // Functions from base classes
       
    95         // None
       
    96         
       
    97     protected:  // New functions
       
    98         // None
       
    99         
       
   100     protected:  // Functions from base classes
       
   101         // None
       
   102         
       
   103     private:
       
   104         // None
       
   105         
       
   106     public:     //Data
       
   107         // None
       
   108         
       
   109     protected:  // Data
       
   110         // None
       
   111         
       
   112     private:    // Data
       
   113         /**
       
   114         * Wait RMessage
       
   115         */
       
   116         RMessage2 iWaitMsg;
       
   117         
       
   118         /**
       
   119         * Wait pending
       
   120         */
       
   121         TBool iWaitPending;
       
   122         
       
   123         /**
       
   124         * StateEventPending.
       
   125         */ 
       
   126         TBool iStateEventPending;
       
   127         
       
   128         /**
       
   129         * Unset status.
       
   130         */ 
       
   131         TRequestStatus* iStatus;
       
   132         
       
   133     public:     // Friend classes
       
   134         // None
       
   135 
       
   136     protected:  // Friend classes
       
   137         // None
       
   138 
       
   139     private:    // Friend classes
       
   140         // None
       
   141     };
       
   142 
       
   143 #endif      // TESTENGINEEVENT_H
       
   144 
       
   145 // End of File