C:/Data/Dev/Synergy/MCL/lbs/lbs/locationmgmt/locmonitor/lbslocmonitorapis/ConversionDataTypes/inc/lbslocationwcdmainfo.h File Reference

#include <e32base.h>
#include <lbs/lbslocationcommon.h>
#include <lbs/lbslocationwcdmaneighbourinfo.h>

Go to the source code of this file.

Functions

 NONSHARABLE_CLASS (CLbsWcdmaCellInfo)

Detailed Description


Function Documentation

NONSHARABLE_CLASS ( CLbsWcdmaCellInfo   ) 

This class contains information related to a cell in WCDMA PLMN. An instance of this class may also contain information of one or more neighbouring WCDMA cells

Allocates and constructs a new WCDMA cell info object. In the returned instance, the country code, network code and cell ID are set to zero.

Returns:
Pointer to the new WCDMA cell info object. Standard symbian error codes, such as KErrNoMemory

Allocates and constructs a new WCDMA cell info object.

Parameters:
[in] aCountryCode Network country code.
[in] aNetworkCode Network code.
[in] aUniqueCellId Cell ID of a cell in WCDMA PLMN.
Returns:
Pointer to the new WCDMA cell info object. KErrArgument in case of invalid input or other standard symbian error codes, such as KErrNoMemory.

Allocates and constructs a WCDMA cell info object, a copy of another one.

Parameters:
[in] aLocality Instance of CLbsWcdmaCellInfo.

Destructor

Initializes the country code attribute.

Parameters:
[in] aCountryCode Network country code, range 0..999

Retrieves the country code information.

Returns:
Network country code, range 0..999 KErrNotFound if the value is undefined.

Initializes the network code attribute.

Parameters:
[in] aNetworkCode Network code, range 0..999

Retrieves the network code information.

Returns:
Network code, range 0..999 KErrNotFound if the value is undefined.

Sets the Cell Identity.

Parameters:
[in] aUniqueCellId Cell Identity, range 0..268435455.

Retrieves the Cell Identity.

Returns:
Cell Identity, range 0..268435455. KErrNotFound if the value is undefined.

Sets the scrambling code

Parameters:
[in] aScramblingCode scrambling code , range 0..511.

Retrieves the scrambling code .

Returns:
Base scrambling code, range 0..511. KErrNotFound if the value is undefined.

Sets the RSSI parameter

Parameters:
[in] aRssi Received Signal Strength Indicator, range 0..127.

Retrieves the RSSI information.

Returns:
RSSI, range 0..127. KErrNotFound if the value is undefined.

Adds a neighbouring cell information.

Parameters:
[in] An instance of TLbsWcdmaNeighbourCellInfo class (memory ovnership is being transferred) KErrArgument if the argument is NULL or one of standard symbian error codes

Retrieves a copy of neighbouring cell information information as an array.

Parameters:
[in] aNeighbourCellInfo WCDMA neighbouring cell information (memory ownership is not being transferred to this function therefore it is the responsibility of the caller to ensure Close() is called to free resources)

Removes all neighbouring cell information.

Returns the type of area information instance.

Returns:
Area type information

Validates WCDMA information. This method checks for boundary conditions as well as the mandatory attributes. The attributes of this class become mandatory in a hierarchical manner. For instance, if scrambling code is specified then, all other attributes except the neighbouring cell information become mandatory. However, the mobile country code attribute is always mandatory which means client applications must at least specify the MCC attribute when specifying WCDMA cell information. This method is used internally to determine the correctness of information provided. Optionally, this method, may also be used by client applications to validate their input.

KErrArgument If the specified attributes dont meet the boundary conditions or the mandatory arguments are not specified.

Internalize method to write WCDMA cell information to a stream.

Externalize method to read WCDMA cell information from a stream.

C++ default constructor

Copy constructor. Prohibited by default.

Overloaded assignment operator. Prohibited by default.

Symbian 2 phase constructor

Symbian 2 phase constructor

Mobile country code

Mobile network code

Unique cell identifier

Scrambling code

RSSI

Data mask to determine initialized data. Used internally.

Neighbouring cell info


Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. These materials are provided under the terms of the Eclipse Public License v1.0.