EPOC   SDK Home Glossary Indexes Previous Next Up

MBasicGsmPhoneSignalandBer class


Contents


MBasicGsmPhoneSignalandBer class — Protocol for accessing signal strength and bit error rate information

Section Contents


Overview

Derivation

MBasicGsmPhoneSignalandBer

Mixin: interface for accessing signal strength and bit error rate information.

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

This class defines the protocol for accessing phone signal strength and bit error rate information.


Construction and destruction


MBasicGsmPhoneSignalandBer() — Protected default C++ constructor

protected: MBasicGsmPhoneSignalandBer()

Description

The default C++ constructor is protected, which prevents objects of this class from being constructed. This class is intended only as an abstract base for other classes.


Signal strength and bit error rate capability functions


GetSignalCaps() — Get signal strength and bit error rate capabilities

virtual TInt GetSignalCaps(TSignalAndBerCapsFlags& aCaps) const=0;

Description

This function retrieves the signal and bit error rate capabilities of the phone.

Arguments

TSignalAndBerCapsFlags& aCaps

On return, contains the signal and bit error rate capabilities.

Return value

TInt

An error code: see System error codes.


NotifySignalCaps() — Notification of a change in signal strength and BER capabilities

virtual void NotifySignalCaps(TRequestStatus& aStatus, TSignalAndBerCapsFlags& aCaps)=0;

Description

This function requests notification of a change in the signal and bit error rate capabilities of the phone.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TSignalAndBerCapsFlags& aCaps

On request completion, contains the signal and bit error rate capabilities.


NotifySignalCapsCancel() — Cancel notification of a change in signal strength and BER capabilities

virtual void NotifySignalCapsCancel() const=0;

Description

This function cancels an outstanding signal strength and bit error rate capabilities change notification request, placed using the NotifySignalCaps() function.


Signal strength functions


GetSignalStrength() — Get signal strength — synchronous

virtual TInt GetSignalStrength(TInt32& aSignalStrength) const=0;

Description

This function returns the current phone signal strength.

Arguments

TInt32& aSignalStrength

On return, contains the current phone signal strength (in dBm).

Return value

TInt

An error code: see System error codes.

Notes:

GetSignalStrength() — Get signal strength — asynchronous

virtual void GetSignalStrength(TRequestStatus& aStatus, TInt32& aSignalStrength)=0;

Description

This function asynchronously returns the current phone signal strength.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TInt32& aSignalStrength

On request completion, contains the current phone signal strength (in dBm).

Notes:

GetSignalStrengthCancel() — Cancel request for signal strength information

virtual void GetSignalStrengthCancel() const=0;

Description

This function cancels an outstanding signal strength retrieval request, placed using the asynchronous variant of the GetSignalStrength() function.


SignalStrengthNotification() — Notification of a change of signal strength

virtual void SignalStrengthNotification(TRequestStatus& aStatus,TInt32& aSignalStrength)=0;

Description

This function notifies the client of a change of signal strength.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TInt32& aSignalStrength

On request completion, contains the new signal strength value (in dBm).

Notes:

SignalStrengthNotificationCancel() — Cancel notification of a change of signal strength

virtual void SignalStrengthNotificationCancel() const=0;

Description

This function cancels an outstanding signal strength notification request, placed using the SignalStrengthNotification() function.


Bit error rate functions


GetBer() — Get bit error rate Information — synchronous

virtual TInt GetBer(TUint& aBer) const=0;

Description

This function retrieves the current Bit Error Rate (BER) information.

Arguments

TUint& aBer

On return, contains the current BER information (as a percentage).

Return value

TInt

An error code: see System error codes.

Notes:

GetBer() — Get bit error rate Information — asynchronous

virtual void GetBer(TRequestStatus& aStatus, TUint& aBer)=0;

Description

This function retrieves the current Bit Error Rate (BER) information.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TUint& aBer

On request completion, contains the current BER information (as a percentage).

Notes:

GetBerCancel() — Cancel bit error rate information request

virtual void GetBerCancel() const=0;

Description

This function cancels an outstanding bit error rate retrieval request, placed using the asynchronous version of the GetBer() function.


BerNotification() — Notification of a change in the bit error rate

virtual void BerNotification(TRequestStatus& aStatus,TUint& aBer)=0;

Description

This function provides notification when the Bit Error Rate changes.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TUint& aBer

On request completion, contains the current bit error rate.

Notes:

BerNotificationCancel() — Cancel notification of a change in the bit error rate

virtual void BerNotificationCancel() const=0;

Description

This function cancels an outstanding Bit Error Rate notification request, placed using the BerNotification() function.


Enumerations


TSignalStrengthAndBerCaps enum — Phone signal strength and bit error rate capability flags

KCapsSignalStrength

Indicates that signal strength information is available.

KCapsSignalBer

Indicates that bit error rate information is available.

KCapsSignalStrengthUpdate

Indicates that asynchronous signal strength change notifications are supported.

KCapsSignalBerUpdate

Indicates that asynchronous bit error rate change notifications are supported.


Struct


TSignalAndBerCapsFlags struct — Signal strength and bit error rate information

TUint iSignalCaps

A bitmask of TSignalStrengthAndBerCaps constants.

EPOC       SDK Home Glossary Indexes Previous Next Up