cbsref/telephonyrefplugins/atltsy/integrationtest/inc/testltsysmsatutil.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 testltsysmsatutil.h
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    15
// This contains SmsAtUtil which is util for Sms At command
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 TESTLTSYSMSATUTIL_H
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    19
#define TESTLTSYSMSATUTIL_H
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    20
// system include
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    21
#include <e32std.h>
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    22
#include <e32base.h>
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    23
#include <etelmm.h>
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    24
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    25
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    26
/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    27
*  SmsAtUtil
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    28
* 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    29
*/
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    30
class SmsAtUtil : public CBase
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    31
	{
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    32
public:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    33
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    34
	 /**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    35
	 * Converts aAscii ASCII chars to Semi Octets in aData.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    36
	 * One ASCII char (8bits in aAscii) is translated to one Semi-Octet (4bits in aData).
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    37
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    38
	 * @param aAscii input ascii string
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    39
	 * @param aData  output binary data 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    40
	 * @return Standard KErr... values 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    41
	 */	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    42
	static TInt ConvertAsciiToBinary(const TDesC8& aAscii,TDes8& aData);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    43
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    44
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    45
	 /**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    46
	 * Appends the binary data (aData) onto the end of an ASCII string (aAscii) in ASCII format.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    47
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    48
	 * @param aAscii  an ascii string 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    49
	 * @param aData   a  binary string 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    50
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    51
	static void AppendDataToAscii(TDes8& aAscii,const TDesC8& aData);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    52
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    53
	 /**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    54
	 * Reads an address from the front of the ASCII string (aAscii) and fills up Address structure (aAddress).
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    55
	 * The address read from the ASCII string is removed from the ASCII string.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    56
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    57
	 * @param aAscii an ascii string 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    58
	 * @param aAddress  a SCA address
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    59
	 * @return Standard KErr... values
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    60
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    61
	static TBool IsAddressChar(TChar aChar);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    62
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    63
private:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    64
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    65
	 /**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    66
	 * @param aValue should be an ETSI Numbering-Plan-Identification field
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    67
	 * @return The equivalent RMobilePhone::TMobileNPI value for aValue
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    68
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    69
	static RMobilePhone::TMobileNPI ConvertNumberingPlan(TInt aValue);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    70
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    71
	 /**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    72
	 * @param aValue should be an ETSI Type-Of-Number field
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    73
	 * @return The equivalent RMobilePhone::TMobileTON value for aValue
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    74
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    75
	static RMobilePhone::TMobileTON ConvertTypeOfNumber(TInt aValue); 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    76
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    77
	 /**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    78
	 * Converts a TInt octet value into ASCII representation and then appends that
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    79
	 * ASCII representation to the end of the given ASCII string.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    80
	 *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    81
	 * @param aOctet the octet value to append
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    82
	 * @param aAscii the ASCII string to which aOctet value should be appended
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    83
	 */	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    84
	static void AppendOctet(TInt aOctet,TDes8& aAscii);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    85
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    86
	 /**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    87
	 * Returns the equivalent numeric value for a given ASCII address character.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    88
	 *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    89
	 * @param aChar the address character to be converted
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    90
	 * @return The numeric value equivalent of the given address character.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    91
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    92
	static TInt ConvertAddressChar(TChar aChar);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    93
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    94
	 /**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    95
	 * Returns the equivalent ASCII address character for a given address value.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    96
	 *
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    97
	 * @param aBinary the numerix value of the address character to be returned
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    98
	 * @return The ASCII charcater which represents the given address numeric value.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    99
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   100
	static TChar ConvertAddressChar(TInt aBinary);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   101
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   102
	};
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   103
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   104
#endif // TESTLTSYSMSATUTIL_H