cbsref/telephonyrefplugins/atltsy/atcommand/phone/inc/atgetmodemstatus.h
changeset 49 f50f4094acd7
equal deleted inserted replaced
48:14460bf2a402 49:f50f4094acd7
       
     1 // Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // @file atgetmodemstatus.h
       
    15 // This contains CATGetModemStatus which is defines the AT command for Getting modem staus
       
    16 // 
       
    17 
       
    18 /**
       
    19  * @file
       
    20  *
       
    21  * AT command definition
       
    22  * This file defines the AT command for Getting Modem status
       
    23  * This queries the ME (Mobile Equipment) Modem,
       
    24  * using a standard (ETSI GSM 07.07 April 1997) AT command : AT
       
    25  * 
       
    26  */
       
    27 
       
    28 #ifndef __CMODEMSTATUS_H__
       
    29 #define __CMODEMSTATUS_H__
       
    30 
       
    31 //user include
       
    32 #include "atcommandbase.h"
       
    33 
       
    34 
       
    35 /**
       
    36  * \class CATGetModemStatus 
       
    37  * \brief get Modem status.
       
    38  *
       
    39  * CATGetModemStatus inherits from the CAtCommandBase class. 
       
    40  * This class transmits the AT Command in order to get Modem status 
       
    41  * in the phone, using a standard AT command : AT+CGSN
       
    42  */
       
    43 class CATGetModemStatus : public CAtCommandBase
       
    44 {
       
    45 public:
       
    46 	static CATGetModemStatus* NewL(CGlobalPhonemanager& aGloblePhone, 
       
    47 		                           CCtsyDispatcherCallback& aCtsyDispatcherCallback);
       
    48 	/**
       
    49 	 * Destructor
       
    50 	 *
       
    51 	 */
       
    52 	~CATGetModemStatus();
       
    53 
       
    54 	/**
       
    55 	 * Virtual function. Inherited from CAtCommandBase
       
    56 	 *  Start Execute AT Command
       
    57 	 */
       
    58 	virtual void ExecuteCommand();
       
    59 	/**
       
    60 	 * Virtual function. Inherited from CAtCommandBase
       
    61 	 * @param aResponseBuf Line buf reading from baseband 
       
    62 	 */
       
    63 	virtual void ParseResponseL(const TDesC8& aResponseBuf);
       
    64 	/**
       
    65 	 * Will be called by AT Manager whenever a event was triggered
       
    66 	 * 
       
    67 	 * @param aEventSource
       
    68 	 * @param aStatus
       
    69 	 */
       
    70 	virtual void EventSignal(TAtEventSource aEventSource, TInt aStatus);
       
    71 	/**
       
    72 	 * Get error value executed AT Command
       
    73 	 */
       
    74 	TInt GetErrorValue();
       
    75 	/**
       
    76 	 * Start this request
       
    77 	 */
       
    78 	virtual void StartRequest();
       
    79 	
       
    80 	/**
       
    81 	 * Start this request
       
    82 	 */
       
    83 	void Complete(TInt aError);
       
    84 	
       
    85 protected:
       
    86 	/**
       
    87 	 * Constructor
       
    88 	 *
       
    89 	 * @param aGloblePhone
       
    90 	 * @param aCtsyDispatcherCallback
       
    91 	 */
       
    92 	CATGetModemStatus(CGlobalPhonemanager& aGloblePhone, 
       
    93 		              CCtsyDispatcherCallback& aCtsyDispatcherCallback);
       
    94 	/**
       
    95 	 * 2nd Constructor
       
    96 	 */
       
    97 	void ConstructL();
       
    98 private:
       
    99 	/**
       
   100 	 * The return error value of AT command executed 
       
   101 	 */
       
   102 	TInt iError;
       
   103 
       
   104 };
       
   105 #endif