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

#include <e32std.h>
#include <lbs/lbslocationcommon.h>

Go to the source code of this file.

Typedefs

typedef TBuf8
< KLbsWlanMacAddressLength
TLbsWlanMacAddress

Functions

 NONSHARABLE_CLASS (CLbsWlanInfo)

Variables

const TInt KLbsWlanMacAddressLength = 18

Detailed Description


Typedef Documentation

WLAN MAC address consists of six hex numbers and is typically represented as a string with 6, colon separated hexadecimal numbers. (e.g. 11:22:33:44:55:66)

In order so save memory the LBS subsystem does not use a string. A 6 byte long buffer is used instead.

The leftmost number of the MAC address ("11" in the example) is stored in the first byte of the buffer. The rightmost number of the MAC address ("66" in the example) is stored in the last byte of the buffer.


Function Documentation

NONSHARABLE_CLASS ( CLbsWlanInfo   ) 

This class contains information related to a WLAN radio map object.

Allocates and constructs a new WLAN info object. In the returned instance, the MAC ID and signal strength values are set to zero.

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

Allocates and constructs a new WLAN info object.

The validation for the arguments is hierarchical. For instance, if signal strength is given, then specifying MAC ID is mandatory.

Parameters:
[in] aMacAddress MAC address of the WLAN AP.
[in] aRxStrength AP signal strength received at the SET.
Returns:
Pointer to the new WLAN info object. KErrArgument in case of invalid input or other standard symbian error codes, such as KErrNoMemory.

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

Parameters:
[in] aLocality Instance of CLbsWlanInfo.

Destructor

Initializes the MAC ID attribute.

Parameters:
[in] aMacAddress MAC address of the WLAN AP

Retrieves the MAC ID information.

Initializes the AP signal strength received at the SET.

Parameters:
[in] aRxStrength AP signal strength received at the SET, range 0..255

Retrieves the AP signal strength received at the SET.

Returns:
AP signal strength received at the SET, range 0..255 KErrNotFound if the value is undefined.

Returns the type of area information instance.

Returns:
Area type information

Validates WLAN information. This method checks for boundary conditions as well as the mandatory attributes. All attributes of this class are mandatory. 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 WLAN information to a stream.

Externalize method to read WLAN 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

MAC code

Received signal strength


Variable Documentation

const TInt KLbsWlanMacAddressLength = 18

Length of a WLAN MAC address.


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.