cbsref/telephonyrefplugins/atltsy/atcommand/generic/inc/athelpercommand.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 athelpercommand.h
       
    15 // 
       
    16 
       
    17 
       
    18 #ifndef __ATHELPERCOMMAND_H__
       
    19 #define __ATHELPERCOMMAND_H__
       
    20 
       
    21 //user include
       
    22 #include "atcommandbase.h"
       
    23 
       
    24 /**
       
    25  * \class CATHelperCommand 
       
    26  * \brief get Modem status.
       
    27  *
       
    28  * CATHelperCommand inherits from the CAtCommandBase class. 
       
    29  * This file defines the AT command for simple AT command 
       
    30  * which only return OK or Error
       
    31  */
       
    32 class CATHelperCommand : public CAtCommandBase
       
    33 {
       
    34 public:
       
    35 	static CATHelperCommand* NewL(CGlobalPhonemanager& aGloblePhone, 
       
    36 		                           CCtsyDispatcherCallback& aCtsyDispatcherCallback);
       
    37 	/**
       
    38 	 * Destructor
       
    39 	 *
       
    40 	 */
       
    41 	~CATHelperCommand();
       
    42 
       
    43 	/**
       
    44 	 * Virtual function. Inherited from CAtCommandBase
       
    45 	 *  Start Execute AT Command
       
    46 	 */
       
    47 	virtual void ExecuteCommand();
       
    48 	/**
       
    49 	 * Virtual function. Inherited from CAtCommandBase
       
    50 	 * Cancel the AT Command execution
       
    51 	 */
       
    52 	virtual void CancelCommand();
       
    53 	/**
       
    54 	 * Virtual function. Inherited from CAtCommandBase
       
    55 	 * @param aResponseBuf Line buf reading from baseband 
       
    56 	 */
       
    57 	virtual void ParseResponseL(const TDesC8& aResponseBuf);
       
    58 	/**
       
    59 	 * Get error value executed AT Command
       
    60 	 */
       
    61 	TInt GetErrorValue();
       
    62 	/**
       
    63 	 * Set the string which should be executed AT Command
       
    64 	 */
       
    65 	void SetAtCommandString(const TDesC8& aATString);
       
    66 	/**
       
    67 	 * Start this request
       
    68 	 */
       
    69 	virtual void StartRequest();
       
    70 	/**
       
    71 	 * Start this request
       
    72 	 */
       
    73 	void SetATType(TLtsyATCommandType aATType);
       
    74 	
       
    75 protected:
       
    76 	/**
       
    77 	 * Constructor
       
    78 	 *
       
    79 	 * @param aGloblePhone
       
    80 	 * @param aCtsyDispatcherCallback
       
    81 	 */
       
    82 	CATHelperCommand(CGlobalPhonemanager& aGloblePhone, 
       
    83 		              CCtsyDispatcherCallback& aCtsyDispatcherCallback);
       
    84 	/**
       
    85 	 * 2nd Constructor
       
    86 	 */
       
    87 	void ConstructL();
       
    88 private:
       
    89 	/**
       
    90 	 * The return error value of AT command executed 
       
    91 	 */
       
    92 	TInt iError;
       
    93 	/**
       
    94 	* The buffer contains the "AT" String which should be sent to BaseBand Modem
       
    95 	*/
       
    96 	TBuf8<KLtsyGenericBufferSize> iATBuffer;
       
    97 
       
    98 };
       
    99 #endif //__ATHELPERCOMMAND_H__