1 /*

     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Definition of geo gsm cell class.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef LBTGEOGSMCELL_H

    21 #define LBTGEOGSMCELL_H

    22 

    23 #include "lbtgeocell.h"

    24 

    25 

    26 /**

    27  * Geographical Gsm cell.

    28  *  

    29  * CLbtGeoGsmCell class is defined by the area covered by a GSM network

    30  *  cell.

    31  *  

    32  * @lib lbt.lib

    33  *

    34  * @since S60 5.1

    35  */

    36  

    37 class CLbtGeoGsmCell : public CLbtGeoCell

    38     {

    39 public:

    40     /**

    41      * Allocates and constructs a new geographical GSM cellular area object.

    42      * In the returned object,the country code,network code,location area code and  

    43      * cell id are set to zero.

    44      * @return Pointer to the new geographical cellular area object.

    45      */

    46      IMPORT_C static CLbtGeoGsmCell* NewL();

    47     

    48     /**

    49      * Allocates and constructs a new geographical GSM cellular area object and

    50      * pushes it onto cleanup stack. 

    51      * In the returned object,the country code,network code,location area code and  

    52      * cell id are set to zero.

    53      * @return Pointer to the new geographical cellular area object.

    54      */

    55      IMPORT_C static CLbtGeoGsmCell* NewLC();

    56     

    57     /**

    58      * Allocates and constructs a new geographical GSM cellular area object.

    59      * 

    60      * @panic ELbtErrArgument If inputs are negative or zero.

    61      * 

    62      * @param[in] aNetworkType The network type

    63      * @param[in] aCountryCode The network country code

    64      * @param[in] aNetworkId The network identity code

    65      * @param[in] aLocationAreaCode The location area code

    66      * @param[in] aCellId The cell id 

    67      * @return Pointer to the new geographical cellular area object.

    68      */

    69      IMPORT_C static CLbtGeoGsmCell* NewL(RMobilePhone::TMobilePhoneNetworkMode aNetworkType,

    70 		                                  RMobilePhone::TMobilePhoneNetworkCountryCode aCountryCode,

    71 		                                  RMobilePhone::TMobilePhoneNetworkIdentity aNetworkId,

    72 		                                  TUint aLocationAreaCode,

    73 		                                  TUint aCellId);

    74     

    75     /**

    76      * Allocates and constructs a new geographical GSM cellular area object and

    77      * pushes it onto cleanup stack. 

    78      *

    79      * @panic ELbtErrArgument If inputs are negative or zero.

    80      * 

    81      * @param[in] aNetworkType The network type

    82      * @param[in] aCountryCode The network country code

    83      * @param[in] aNetworkId The network identity code

    84      * @param[in] aLocationAreaCode The location area code

    85      * @param[in] aCellId The cell id 

    86      * @return Pointer to the new geographical cellular area object.

    87      */                                      

    88      IMPORT_C static CLbtGeoGsmCell* NewLC(RMobilePhone::TMobilePhoneNetworkMode aNetworkType,

    89 		                                   RMobilePhone::TMobilePhoneNetworkCountryCode aCountryCode,

    90 		                                   RMobilePhone::TMobilePhoneNetworkIdentity aNetworkId,

    91 		                                   TUint aLocationAreaCode,

    92 		                                   TUint aCellId);

    93        

    94     /**

    95      * Destructor.

    96      */

    97      IMPORT_C virtual ~CLbtGeoGsmCell();

    98     

    99         

   100     /**

   101      * Sets the BSIC array.

   102      *

   103      * aparam[in] aBsicArray The Bsic array

   104      */ 

   105      IMPORT_C void SetBsic( RArray<TInt>& aBsicArray );

   106      

   107     /**

   108      * Gets the BSIC array.

   109      *

   110      * @return The Bsic array

   111      */

   112 	 IMPORT_C RArray<TInt>& Bsic();	

   113 	 

   114 	/**

   115      * Returns ETrue if the CGI information is specified by client during creation.

   116      * Returns EFalse  otherwise.

   117      */

   118     IMPORT_C virtual TBool CGISpecifiedDuringCreation() const;

   119 

   120 protected:

   121     /**

   122      * Externalize method that subclass must implement.

   123      * @param[in] aStream Stream to which the object should be externalized.

   124      */

   125     virtual void DoExternalizeL(RWriteStream& aStream) const ;

   126     

   127     /**

   128      * Internalize method that subclass must implement.

   129      * @param[in] aStream Stream from which the object should be internalized.

   130      */

   131     virtual void DoInternalizeL(RReadStream& aStream)  ;	

   132 

   133 private:

   134     /**

   135      * default constructor

   136      */

   137     CLbtGeoGsmCell();

   138     

   139     /**

   140      * By default, prohibit copy constructor

   141      */

   142     CLbtGeoGsmCell( const CLbtGeoGsmCell& );

   143     

   144     /**

   145      * Prohibit assigment operator

   146      */

   147     CLbtGeoGsmCell& operator= ( const CLbtGeoGsmCell& );

   148    

   149 

   150 private: // data

   151     /**

   152      * Bsic array

   153      */

   154     RArray<TInt>   iBsicArray;     

   155 	};

   156 

   157 

   158 #endif //LBTGEOGSMCELL_H