cbsref/telephonyrefplugins/atltsy/atcommand/phonebooken/inc/atphbkenread.h
author hgs
Tue, 22 Jun 2010 11:02:32 +0100
changeset 44 8b72faa1200f
permissions -rw-r--r--
201024_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
44
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     1
// Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     2
// All rights reserved.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     7
//
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     8
// Initial Contributors:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    10
//
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    11
// Contributors:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    12
//
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    13
// Description:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    14
// @file atphbkenread.h
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    15
// This contains CAtPhbkEnRead which is use to read a PhonebookEn Entry
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    16
// 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    17
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    18
#ifndef ATPHBKENREAD_H
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    19
#define ATPHBKENREAD_H
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    20
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    21
//system include 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    22
#include <e32std.h>
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    23
#include <e32base.h>
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    24
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    25
//user include 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    26
#include "atcommandbase.h"
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    27
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    28
//constant defination
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    29
const TInt KEnNumberLen = 6;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    30
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    31
/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    32
 * CAtPhbkEnRead
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    33
 *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    34
 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    35
class CAtPhbkEnRead : public CAtCommandBase
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    36
	{
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    37
public:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    38
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    39
	* Destructor
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    40
	*
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    41
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    42
	~CAtPhbkEnRead();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    43
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    44
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    45
	*  static NewL  
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    46
	*
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    47
	* @param aGloblePhone
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    48
	* @param aCtsyDispatcherCallback
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    49
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    50
	static CAtPhbkEnRead* NewL(CGlobalPhonemanager& aGloblePhone, 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    51
                                  CCtsyDispatcherCallback& aCtsyDispatcherCallback);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    52
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    53
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    54
	*  static NewLC  
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    55
	*
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    56
	* @param aGloblePhone
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    57
	* @param aCtsyDispatcherCallback
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    58
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    59
	static CAtPhbkEnRead* NewLC(CGlobalPhonemanager& aGloblePhone, 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    60
                                   CCtsyDispatcherCallback& aCtsyDispatcherCallback);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    61
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    62
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    63
	* Virtual function. Inherited from CAtCommandBase
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    64
	*  Start Execute AT Command
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    65
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    66
	virtual void ExecuteCommand();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    67
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    68
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    69
	* Will be called by AT Manager whenever a event was triggered
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    70
	* 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    71
	* @param aEventSource
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    72
	* @param aStatus
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    73
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    74
	virtual void EventSignal(TAtEventSource aEventSource, TInt aStatus);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    75
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    76
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    77
	* Virtual function. Inherited from CAtCommandBase
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    78
	* 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    79
	* @param aResponseBuf Line buf reading from baseband 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    80
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    81
	virtual void ParseResponseL(const TDesC8& aResponseBuf);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    82
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    83
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    84
	* Start this request
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    85
	* 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    86
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    87
	void StartRequest();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    88
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    89
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    90
	* Set read PhonebookEn index
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    91
	* 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    92
	* @param  aIndex
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    93
	* @param  aSlotNum
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    94
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    95
	void SetIndex(TInt aIndex);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    96
protected:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    97
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    98
	* Constructor
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    99
	*
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   100
	* @param aGloblePhone
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   101
	* @param aCtsyDispatcherCallback
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   102
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   103
	CAtPhbkEnRead(CGlobalPhonemanager& aGloblePhone, 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   104
                     CCtsyDispatcherCallback& aCtsyDispatcherCallback);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   105
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   106
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   107
	* 2nd Constructor
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   108
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   109
	void ConstructL();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   110
private:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   111
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   112
	*  Executer AT command for reading a phonebook entry
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   113
	*/	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   114
	void ReadEntry();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   115
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   116
private:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   117
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   118
	*  state machine for EventSignal 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   119
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   120
	enum 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   121
		{
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   122
		ESetEnName,
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   123
		ESetEnNameComplete,
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   124
		EReadEntry,
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   125
		EReadEntryComplete,
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   126
		EATNotInProgress
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   127
		}iState;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   128
		
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   129
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   130
	* The return error value of AT command executed 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   131
	*/		
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   132
	TInt iError;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   133
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   134
	/*
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   135
	* the first index should be read
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   136
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   137
	TInt iIndex;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   138
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   139
	/*
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   140
	* the phonebooken number want to read
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   141
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   142
	TBuf<KEnNumberLen> iNumber;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   143
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   144
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   145
	/*
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   146
	*  indicate whether it is OK or ERROR string 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   147
	*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   148
    TBool   iEndFlag;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   149
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   150
	}; // class CAtPhbkEnRead
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   151
#endif // ATPHBKENREAD_H