cbsref/telephonyrefplugins/atltsy/atcommand/phone/inc/atgetmodemstatus.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 atgetmodemstatus.h
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    15
// This contains CATGetModemStatus which is defines the AT command for Getting modem staus
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    16
// 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    17
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    18
/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    19
 * @file
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    20
 *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    21
 * AT command definition
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    22
 * This file defines the AT command for Getting Modem status
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    23
 * This queries the ME (Mobile Equipment) Modem,
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    24
 * using a standard (ETSI GSM 07.07 April 1997) AT command : AT
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    25
 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    26
 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    27
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    28
#ifndef __CMODEMSTATUS_H__
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    29
#define __CMODEMSTATUS_H__
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    30
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    31
//user include
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    32
#include "atcommandbase.h"
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    33
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    34
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    35
/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    36
 * \class CATGetModemStatus 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    37
 * \brief get Modem status.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    38
 *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    39
 * CATGetModemStatus inherits from the CAtCommandBase class. 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    40
 * This class transmits the AT Command in order to get Modem status 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    41
 * in the phone, using a standard AT command : AT+CGSN
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    42
 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    43
class CATGetModemStatus : public CAtCommandBase
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    44
{
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    45
public:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    46
	static CATGetModemStatus* NewL(CGlobalPhonemanager& aGloblePhone, 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    47
		                           CCtsyDispatcherCallback& aCtsyDispatcherCallback);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    48
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    49
	 * Destructor
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    50
	 *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    51
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    52
	~CATGetModemStatus();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    53
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    54
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    55
	 * Virtual function. Inherited from CAtCommandBase
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    56
	 *  Start Execute AT Command
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    57
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    58
	virtual void ExecuteCommand();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    59
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    60
	 * Virtual function. Inherited from CAtCommandBase
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    61
	 * @param aResponseBuf Line buf reading from baseband 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    62
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    63
	virtual void ParseResponseL(const TDesC8& aResponseBuf);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    64
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    65
	 * Will be called by AT Manager whenever a event was triggered
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    66
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    67
	 * @param aEventSource
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    68
	 * @param aStatus
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    69
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    70
	virtual void EventSignal(TAtEventSource aEventSource, TInt aStatus);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    71
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    72
	 * Get error value executed AT Command
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    73
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    74
	TInt GetErrorValue();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    75
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    76
	 * Start this request
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    77
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    78
	virtual void StartRequest();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    79
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    80
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    81
	 * Start this request
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    82
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    83
	void Complete(TInt aError);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    84
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    85
protected:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    86
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    87
	 * Constructor
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    88
	 *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    89
	 * @param aGloblePhone
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    90
	 * @param aCtsyDispatcherCallback
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    91
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    92
	CATGetModemStatus(CGlobalPhonemanager& aGloblePhone, 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    93
		              CCtsyDispatcherCallback& aCtsyDispatcherCallback);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    94
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    95
	 * 2nd Constructor
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    96
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    97
	void ConstructL();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    98
private:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    99
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   100
	 * The return error value of AT command executed 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   101
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   102
	TInt iError;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   103
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   104
};
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   105
#endif