Home · All Classes · Grouped Classes · Annotated · Functions

QSimEnvelope Class Reference

The QSimEnvelope class specifies the contents of a SIM ENVELOPE message. More...

    #include <QSimEnvelope>

Public Types

Public Functions

Static Public Members


Detailed Description

The QSimEnvelope class specifies the contents of a SIM ENVELOPE message.

Envelopes are specified by 3GPP TS 11.14 and are used for a variety of purposes when communicating with SIM's, including:

The particular type of envelope is specified by the type() function. Other functions, such as menuItem(), requestHelp(), etc, are used to specify type-specific parameters for the envelope.

See also QSimToolkit, QSimCommand, and QSimTerminalResponse.


Member Type Documentation

enum QSimEnvelope::Event

This enum defines the type of event for a EventDownload envelope, according to 3GPP TS 11.14, section 12.25.

ConstantValueDescription
QSimEnvelope::NoEvent-1No event type defined.
QSimEnvelope::MTCall0Mobile-terminated call event.
QSimEnvelope::CallConnected1Call connected event.
QSimEnvelope::CallDisconnected2Call disconnected event.
QSimEnvelope::LocationStatus3Location status event.
QSimEnvelope::UserActivity4User activity event.
QSimEnvelope::IdleScreenAvailable5Idle screen available event.
QSimEnvelope::CardReaderStatus6Additional card reader status event.
QSimEnvelope::LanguageSelection7Language selection event.
QSimEnvelope::BrowserTermination8Browser termination event.
QSimEnvelope::DataAvailable9Channel data available event.
QSimEnvelope::ChannelStatus10Channel status event.

enum QSimEnvelope::Type

This enum defines the type of QSimEnvelope request to be sent to a SIM.

ConstantValueDescription
QSimEnvelope::NoEnvelope-1The envelope type has not yet been set.
QSimEnvelope::SMSPPDownload0xD1The envelope is being used for an SMS-PP download.
QSimEnvelope::CellBroadcastDownload0xD2The envelope is being used for a cell broadcast download.
QSimEnvelope::MenuSelection0xD3The envelope is being used for a SIM toolkit menu selection.
QSimEnvelope::CallControl0xD4The envelope is being used for call control.
QSimEnvelope::MOSMSControl0xD5The envelope is being used for mobile-originated short message control.
QSimEnvelope::EventDownload0xD6The envelope is being used for event download.
QSimEnvelope::TimerExpiration0xD7The envelope is being used to report timer expiration.


Member Function Documentation

QSimEnvelope::QSimEnvelope ()

Construct a new envelope object with default parameters.

QSimEnvelope::QSimEnvelope ( const QSimEnvelope & value )

Construct a new envelope object as a copy of value.

QSimEnvelope::~QSimEnvelope ()

Destruct an envelope object.

void QSimEnvelope::addExtensionField ( int tag, const QByteArray & value )

Adds an extension field to the data from extensionData(). The field will have the specified tag and contents given by value.

See also extensionField().

QSimCommand::Device QSimEnvelope::destinationDevice () const

Returns the destination device that will receive the envelope. The default value is QSimCommand::SIM.

Applies to: all commands.

See also setDestinationDevice().

QSimEnvelope::Event QSimEnvelope::event () const

Returns the event type for EventDownload envelopes. The default value is NoEvent.

Applies to: EventDownload

See also setEvent().

QByteArray QSimEnvelope::extensionData () const

Returns the extension data for this envelope. The extension data is appended after all other fields, and consists of zero or more BER tag-length-value field specifications.

See also setExtensionData() and extensionField().

QByteArray QSimEnvelope::extensionField ( int tag ) const

Returns the contents of an extension field. The tag is an 8-bit value, from 3GPP TS 11.14, that specifies the particular field the caller is interested in. The most significant bit of tag is ignored when searching for the field, as it contains the "must comprehend" status from 3GPP TS 11.14, and is not important for locating the desired field.

This is a simpler method than extensionData() for accessing values within the extension data.

See also addExtensionField().

QSimEnvelope QSimEnvelope::fromPdu ( const QByteArray & pdu )   [static]

Returns an envelope object corresponding to the data in pdu. The data is decoded as described in 3GPP TS 11.14.

See also toPdu().

uint QSimEnvelope::menuItem () const

Returns the menu item to be selected. The default value is zero.

Applies to: MenuSelection

See also setMenuItem().

bool QSimEnvelope::requestHelp () const

Returns true if help has been requested for this menu selection; false if the menu item is being selected normally. The default value is false.

Applies to: MenuSelection

See also setRequestHelp().

void QSimEnvelope::setDestinationDevice ( QSimCommand::Device value )

Sets the destination device that will receive the envelope to value.

Applies to: all commands.

See also destinationDevice().

void QSimEnvelope::setEvent ( QSimEnvelope::Event value )

Sets the event type for EventDownload envelopes to value.

Applies to: EventDownload

See also event().

void QSimEnvelope::setExtensionData ( QByteArray value )

Sets the extension data for this envelope to value. The extension data is appended after all other fields, and consists of zero or more BER tag-length-value field specifications.

See also extensionData() and addExtensionField().

void QSimEnvelope::setMenuItem ( uint value )

Sets the menu item to be selected to value.

Applies to: MenuSelection

See also menuItem().

void QSimEnvelope::setRequestHelp ( bool value )

Sets the help request flag to value. If value is true, then help has been requested for this menu selection. If value is false, then the menu item is being selected normally.

Applies to: MenuSelection

See also requestHelp().

void QSimEnvelope::setSourceDevice ( QSimCommand::Device value )

Sets the source device that generated the envelope to value.

Applies to: all commands.

See also sourceDevice().

void QSimEnvelope::setType ( QSimEnvelope::Type value )

Sets the type of this envelope to value.

See also type().

QSimCommand::Device QSimEnvelope::sourceDevice () const

Returns the source device that generated the envelope. The default value is QSimCommand::ME.

Applies to: all commands.

See also setSourceDevice().

QByteArray QSimEnvelope::toPdu () const

Returns the PDU form of this envelope, encoded as described in 3GPP TS 11.14.

See also fromPdu().

QSimEnvelope::Type QSimEnvelope::type () const

Returns the type of this envelope.

See also setType().

QSimEnvelope & QSimEnvelope::operator= ( const QSimEnvelope & value )

Copy the QSimEnvelope value.


Copyright © 2008 Nokia Trademarks
Qtopia 4.3.3