EPOC   SDK Home Glossary Indexes Previous Next Up

RBasicGsmPhone class


Contents


RBasicGsmPhone class — GSM Phone sub-session

Section Contents


Overview

Derivation

RPhone

Base class. Defines ETel core phone sub-session functionality.

MBasicGsmPhoneId

mixin: protocol for phone identification information

MBasicGsmPhoneBookSupport

mixin: protocol for phone book support

MBasicGsmPhoneSignalandBer

mixin: protocol for accessing signal strength and bearer information

MBasicGsmPhoneNetwork

mixin: protocol for accessing network capabilities

MBasicGsmPhoneBatteryAndPower

mixin: protocol for accessing phone battery and power capabilities

MBasicGsmPhoneIndicator

mixin: protocol for accessing phone indicator information

MBasicGsmPhoneClockAndAlarm

mixin: protocol for accessing phone clock and alarm capabilities

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

RBasicGsmPhone provides access to basic phone GSM functionality. It is derived from RPhone and a number of mixins, each of which define a certain aspect of Basic GSM phone functionality.

The functions defined in this section are a small subset of those available, the others belonging to, and being documented in, the parent mixin classes.

Writing derived classes

This class is not intended for user derivation


Construction and destruction


RBasicGsmPhone() — Trivial default C++ constructor

RBasicGsmPhone();

Description

The default C++ constructor constructs an RBasicGsmPhone object, specifying the default initialisation for the base class RPhone, and setting the member variable pointers to NULL.


General phone information functions


GetInfoBasicGsm() — Get phone information

TInt GetInfoBasicGsm(TPhoneNotifyInfo& aPhoneNotifyInfo) const;

Description

This function retrieves the current phone information.

Arguments

TPhoneNotifyInfo& aPhoneNotifyInfo

On return, contains the new phone information.

Return value

TInt

An error code: see System error codes.

Notes:

NotifyOnAnythingBasicGsm() — Notification of any changes to the phone information

void NotifyOnAnythingBasicGsm(TRequestStatus& aStatus, TPhoneNotifyInfo& aPhoneNotifyInfo);

Description

This function provides notification of changes in the phone information.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TPhoneNotifyInfo& aPhoneNotifyInfo

On request completion, contains the new phone information.


NotifyOnAnythingBasicGsmCancel() — Cancel notification of changes to the phone information

void NotifyOnAnythingBasicGsmCancel() const;

Description

This function cancels an "Any change" notification request, placed using the NotifyOnAnythingBasicGsm() function.


RBasicGsmPhone::TPhoneNotifyInfo class — GSM Phone Information

Section Contents


Overview

Derivation

RPhone::TPhoneNotifyInfo

Base class: Defines the ETel core API phone information structure.

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

All the information associated with an instance of the basic GSM API phone class is collected together into a single, directly accessible, structure — to increase the efficiency of those applications that require access to the majority of the phone’s data.

Writing derived classes

This class is not intended for user derivation


Construction and destruction


TPhoneNotifyInfo() — Default C++ constructor

RBasicGsmPhone::TPhoneNotifyInfo();

Description

The default C++ constructor constructs an TPhoneNotifyInfo object, specifying the default initialisation for the base class RPhone::TPhoneNotifyInfo.


Data members

TInt32 iSignalStrength

Contains the current signal strength (measured in dBm).

TBool iSignalStrengthChanged

An indication that the signal strength has changed since the last notification.

TUint iBer

Contains the current bit error rate (as a percentage).

TBool iBerChanged

An indication that the bit error rate has changed since the last notification.

MBasicGsmPhoneNetwork::TCurrentNetworkInfo iCurrentNetworkInfo

Contains current network information.

TBool iCurrentNetworkInfoChanged

An indication that the current network information has changed since the last notification.

MBasicGsmPhoneBatteryAndPower::TBatteryInfo iBatteryInfo

Contains current battery and power information.

TBool iBatteryInfoChanged

An indication that the battery and power information has changed since the last notification.

MBasicGsmPhoneIndicator ::TIndicatorInfo iIndicatorInfo

Contains indicator information for a particular phone indicator.

TBool iIndicatorInfoChanged

An indication that the phone indicator information has changed since the last notification.

TNetworkSetMode iNetworkSetMode

Contains the current method of setting the network: manual or automatic.

TBool iNetworkSetModeChanged

An indication that the network setting mode has changed since the last notification.

TRegistrationStatus iNetworkRegistrationStatus

Contains information about the registration status of the current network.

TBool iNetworkRegistrationStatusChanged

An indication that the network registration status has changed since the last notification.

EPOC       SDK Home Glossary Indexes Previous Next Up