mtpdataproviders/mtppictbridgedp/pictbridgeengine/inc/dpsstate.h
author hgs
Fri, 25 Jun 2010 16:54:01 +0800
changeset 29 3ae5cb0b4c02
permissions -rw-r--r--
201025_07
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     1
/*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     2
* Copyright (c) 2006, 2007 Nokia Corporation and/or its subsidiary(-ies).
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     3
* All rights reserved.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     8
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     9
* Initial Contributors:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    11
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    12
* Contributors:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    13
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    14
* Description:  These classes define the dps states. 
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    15
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    16
*/
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    17
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    18
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    19
#ifndef DPSSTATE_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    20
#define DPSSTATE_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    21
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    22
#include <e32base.h>
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    23
class CDpsStateMachine;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    24
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    25
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    26
*   This class is the base classes for all dps state classes.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    27
*   We follow state design pattern here so the state class defines all
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    28
*   transactions among states as member functions.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    29
*/
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    30
class MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    31
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    32
    public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    33
                
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    34
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    35
        *   Script sent notification
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    36
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    37
        virtual void ScriptSentNotifyL(TBool aReply) = 0;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    38
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    39
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    40
        *   Script received notification
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    41
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    42
        virtual void ScriptReceivedNotifyL(TBool aReply) = 0;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    43
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    44
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    45
        *   Error handling of the transaction
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    46
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    47
        virtual void Error(TInt aErr) = 0; 
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    48
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    49
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    50
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    51
*   Idle state class
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    52
*/
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    53
NONSHARABLE_CLASS(TDpsIdleState) : public MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    54
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    55
    public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    56
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    57
        *   Constructor
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    58
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    59
        TDpsIdleState(CDpsStateMachine* aStateMachine);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    60
    public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    61
                
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    62
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    63
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    64
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    65
        void ScriptSentNotifyL(TBool aReply);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    66
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    67
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    68
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    69
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    70
        void ScriptReceivedNotifyL(TBool aReply);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    71
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    72
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    73
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    74
        */    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    75
        void Error(TInt aErr);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    76
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    77
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    78
    private:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    79
        CDpsStateMachine* iStateMachine;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    80
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    81
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    82
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    83
*   Sending Request state class. Device sending request starts form this state
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    84
*/
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    85
NONSHARABLE_CLASS(TDpsSendingReqState) : public MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    86
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    87
    public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    88
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    89
        *   Constructor
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    90
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    91
        TDpsSendingReqState(CDpsStateMachine* aStateMachine);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    92
            
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    93
    public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    94
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    95
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    96
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    97
        */    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    98
        void ScriptSentNotifyL(TBool aReply);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    99
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   100
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   101
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   102
        */    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   103
        void ScriptReceivedNotifyL(TBool aReply);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   104
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   105
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   106
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   107
        */    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   108
        void Error(TInt aErr);        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   109
            
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   110
    private:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   111
        CDpsStateMachine* iStateMachine;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   112
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   113
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   114
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   115
*   Waiting Reply state class (script has been sent)
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   116
*/    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   117
NONSHARABLE_CLASS(TDpsWaitingRepState) : public MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   118
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   119
    public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   120
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   121
        *   Constructor
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   122
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   123
        TDpsWaitingRepState(CDpsStateMachine* aStateMachine);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   124
            
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   125
    public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   126
               
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   127
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   128
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   129
        */    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   130
        void ScriptSentNotifyL(TBool aReply);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   131
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   132
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   133
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   134
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   135
        void ScriptReceivedNotifyL(TBool aReply);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   136
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   137
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   138
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   139
        */    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   140
        void Error(TInt aErr);        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   141
            
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   142
    private:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   143
        CDpsStateMachine* iStateMachine;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   144
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   145
    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   146
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   147
*   Sending Reply state class. The device starts replying the host request 
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   148
*   in this state.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   149
*/     
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   150
NONSHARABLE_CLASS(TDpsSendingRepState) : public MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   151
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   152
    public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   153
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   154
        *   Constructor
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   155
        */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   156
        TDpsSendingRepState(CDpsStateMachine* aStateMachine);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   157
            
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   158
    public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   159
          
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   160
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   161
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   162
        */    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   163
        void ScriptSentNotifyL(TBool aReply);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   164
         
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   165
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   166
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   167
        */    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   168
        void ScriptReceivedNotifyL(TBool aReply);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   169
        
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   170
        /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   171
        *   @see MDpsState
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   172
        */    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   173
        void Error(TInt aErr);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   174
                    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   175
    private:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   176
        CDpsStateMachine* iStateMachine;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   177
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   178
    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   179
#endif