Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QSimTerminalResponse Class Reference
[QtTelephonyModule]

The QSimTerminalResponse class specifies the contents of a SIM toolkit TERMINAL RESPONSE message. More...

    #include <QSimTerminalResponse>

List of all members, including inherited members

Public Types

enum Cause { NoSpecificCause, ScreenIsBusy, BusyOnCall, BusyOnSsTransaction, ..., RequestedTransportNotAvailable }
enum Result { Success, PartialComprehension, MissingInformation, RefreshPerformed, ..., BearerIndependentProtocolProblem }

Public Functions

QSimTerminalResponse ()
QSimTerminalResponse ( const QSimTerminalResponse & value )
~QSimTerminalResponse ()
void addExtensionField ( int tag, const QByteArray & value )
QSimTerminalResponse::Cause cause () const
QByteArray causeData () const
QSimCommand command () const
QByteArray commandPdu () const
int dataCodingScheme () const
QSimCommand::Device destinationDevice () const
uint duration () const
QByteArray extensionData () const
QByteArray extensionField ( int tag ) const
uint menuItem () const
QSimTerminalResponse::Result result () const
void setCause ( QSimTerminalResponse::Cause value )
void setCauseData ( const QByteArray & value )
void setCommand ( const QSimCommand & value )
void setCommandPdu ( const QByteArray & value )
void setDataCodingScheme ( int value )
void setDestinationDevice ( QSimCommand::Device value )
void setDuration ( uint value )
void setExtensionData ( QByteArray value )
void setMenuItem ( uint value )
void setResult ( QSimTerminalResponse::Result value )
void setSourceDevice ( QSimCommand::Device value )
void setText ( const QString & value )
QSimCommand::Device sourceDevice () const
QString text () const
QByteArray toPdu () const
QSimTerminalResponse & operator= ( const QSimTerminalResponse & value )

Static Public Members

QSimTerminalResponse fromPdu ( const QByteArray & pdu )

Detailed Description

The QSimTerminalResponse class specifies the contents of a SIM toolkit TERMINAL RESPONSE message.

Applications that run within a SIM send commands to the host program to interact with the user. These commands might entail choosing an item from a menu, asking if it is OK to dial a phone number, asking for a line of input, displaying text messages, etc.

Once the user picks an action, a TERMINAL RESPONSE message is typically sent back to the SIM to communicate the user's intent. The QSimTerminalResponse class encapsulates a TERMINAL RESPONSE message, containing all of the information about it.

In Qtopia, the host program is simapp.

Member Type Documentation

enum QSimTerminalResponse::Cause

This enum defines the secondary cause code for a TERMINAL RESPONSE message to a SIM, from 3GPP TS 11.14, section 12.12.

Constant	Value	Description
`QSimTerminalResponse::NoSpecificCause`	`0x00`	No specific cause can be given (applies to all results).
`QSimTerminalResponse::ScreenIsBusy`	`0x01`	Screen is busy (applies to `MEUnableToProcess`).
`QSimTerminalResponse::BusyOnCall`	`0x02`	ME currently busy on call (applies to `MEUnableToProcess`).
`QSimTerminalResponse::BusyOnSsTransaction`	`0x03`	ME currently busy on SS transaction (applies to `MEUnableToProcess`).
`QSimTerminalResponse::NoService`	`0x04`	No service (applies to `MEUnableToProcess`).
`QSimTerminalResponse::AccessControlClassBar`	`0x05`	Access control class bar (applies to `MEUnableToProcess`).
`QSimTerminalResponse::RadioResourceNotGranted`	`0x06`	Radio resource not granted (applies to `MEUnableToProcess`).
`QSimTerminalResponse::NotInSpeechCall`	`0x07`	Not in speech call (applies to `MEUnableToProcess`).
`QSimTerminalResponse::BusyOnUssdTransaction`	`0x08`	ME currently busy on USSD transaction (applies to `MEUnableToProcess`).
`QSimTerminalResponse::BusyOnDtmf`	`0x09`	ME currently busy on SEND DTMF command (applies to `MEUnableToProcess`).
`QSimTerminalResponse::ActionNotAllowed`	`0x01`	Action not allowed (applies to `PermanentCallControlProblem`).
`QSimTerminalResponse::TypeOfRequestHasChanged`	`0x02`	The type of request has changed (applies to `PermanentCallControlProblem`).
`QSimTerminalResponse::CardReaderRemovedOrNotPresent`	`0x01`	Card reader removed or not present (applies to `MultipleCardError`).
`QSimTerminalResponse::CardRemovedOrNotPresent`	`0x02`	Card removed or not present (applies to `MultipleCardError`).
`QSimTerminalResponse::CardReaderBusy`	`0x03`	Card reader busy (applies to `MultipleCardError`).
`QSimTerminalResponse::CardPoweredOff`	`0x04`	Card powered off (applies to `MultipleCardError`).
`QSimTerminalResponse::CAPDUFormatError`	`0x05`	C-APDU format error (applies to `MultipleCardError`).
`QSimTerminalResponse::MuteCard`	`0x06`	Mute card (applies to `MultipleCardError`).
`QSimTerminalResponse::TransmissionError`	`0x07`	Transmission error (applies to `MultipleCardError`).
`QSimTerminalResponse::ProtocolNotSupported`	`0x08`	Protocol not supported (applies to `MultipleCardError`).
`QSimTerminalResponse::SpecifiedReaderNotValid`	`0x09`	Specified reader not valid (applies to `MultipleCardError`).
`QSimTerminalResponse::BearerUnavailable`	`0x01`	Bearer unavailable (applies to `LaunchBrowserError`).
`QSimTerminalResponse::BrowserUnavailable`	`0x02`	Browser unavailable (applies to `LaunchBrowserError`).
`QSimTerminalResponse::UnableToReadProvisioningData`	`0x03`	ME unable to read the provisioning data (applies to `LaunchBrowserError`).
`QSimTerminalResponse::NoChannelAvailable`	`0x01`	No channel available (applies to `BearerIndependentProtocolProblem`).
`QSimTerminalResponse::ChannelClosed`	`0x02`	Channel closed (applies to `BearerIndependentProtocolProblem`).
`QSimTerminalResponse::ChannelIdentifierNotValid`	`0x03`	Channel identifier not valid (applies to `BearerIndependentProtocolProblem`).
`QSimTerminalResponse::RequestedBufferSizeNotAvailable`	`0x04`	Requested buffer size not available (applies to `BearerIndependentProtocolProblem`).
`QSimTerminalResponse::SecurityError`	`0x05`	Security error; i.e. unsuccessful authentication (applies to `BearerIndependentProtocolProblem`).
`QSimTerminalResponse::RequestedTransportNotAvailable`	`0x06`	Required SIM/ME interface transport level not available (applies to `BearerIndependentProtocolProblem`).

enum QSimTerminalResponse::Result

This enum defines the primary response code for a TERMINAL RESPONSE message to a SIM, from 3GPP TS 11.14, section 12.12.

Constant	Value	Description
`QSimTerminalResponse::Success`	`0x00`	Command performed successfully.
`QSimTerminalResponse::PartialComprehension`	`0x01`	Command performed with partial comprehension.
`QSimTerminalResponse::MissingInformation`	`0x02`	Command performed with missing information.
`QSimTerminalResponse::RefreshPerformed`	`0x03`	Refresh performed with additional elementary files read.
`QSimTerminalResponse::IconNotDisplayed`	`0x04`	Command performed, but requested icon could not be displayed.
`QSimTerminalResponse::ModifiedCallControl`	`0x05`	Command performed, but modified by call control by SIM.
`QSimTerminalResponse::LimitedService`	`0x06`	Command performed, limited service.
`QSimTerminalResponse::WithModification`	`0x07`	Command performed with modification.
`QSimTerminalResponse::SessionTerminated`	`0x10`	Proactive SIM session terminated by the user.
`QSimTerminalResponse::BackwardMove`	`0x11`	Backward move in proactive SIM session requested by the user.
`QSimTerminalResponse::NoResponseFromUser`	`0x12`	No response from the user.
`QSimTerminalResponse::HelpInformationRequested`	`0x13`	Help information requested by the user.
`QSimTerminalResponse::UssdOrSsTerminatedByUser`	`0x14`	USSD or SS transaction terminated by the user.
`QSimTerminalResponse::MEUnableToProcess`	`0x20`	ME currently unable to process command.
`QSimTerminalResponse::NetworkUnableToProcess`	`0x21`	Network currently unable to process command.
`QSimTerminalResponse::UserDidNotAccept`	`0x22`	User did not accept the practive command.
`QSimTerminalResponse::UserClearedDownCall`	`0x23`	User cleared down call before connection or network release.
`QSimTerminalResponse::ActionInContradictionWithTimer`	`0x24`	Action in contradication with the current timer state.
`QSimTerminalResponse::TemporaryCallControlProblem`	`0x25`	Interaction with call control by SIM, temporary problem.
`QSimTerminalResponse::LaunchBrowserError`	`0x26`	Launch browser generic error code.
`QSimTerminalResponse::BeyondMECapabilities`	`0x30`	Command beyond ME's capabilities.
`QSimTerminalResponse::TypeNotUnderstood`	`0x31`	Command type not understood by ME.
`QSimTerminalResponse::DataNotUnderstood`	`0x32`	Command data not understood by ME.
`QSimTerminalResponse::NumberNotUnderstood`	`0x33`	Command number not understood by ME.
`QSimTerminalResponse::SsReturnError`	`0x34`	SS Return Error.
`QSimTerminalResponse::SmsRpError`	`0x35`	SMS RP-ERROR.
`QSimTerminalResponse::RequiredValuesMissing`	`0x36`	Error, required values are missing.
`QSimTerminalResponse::UssdReturnError`	`0x37`	USSD Return Error.
`QSimTerminalResponse::MultipleCardError`	`0x38`	MultipleCard commands error.
`QSimTerminalResponse::PermanentCallControlProblem`	`0x39`	Interaction with call control by SIM or MO short message control by SIM, permanent problem.
`QSimTerminalResponse::BearerIndependentProtocolProblem`	`0x3A`	Bearer Independent Protocol error.

Member Function Documentation

QSimTerminalResponse::QSimTerminalResponse ()

Construct a new SIM terminal response object with default parameters.

QSimTerminalResponse::QSimTerminalResponse ( const QSimTerminalResponse & value )

Construct a new SIM terminal response object as a copy of value.

QSimTerminalResponse::~QSimTerminalResponse ()

Destruct a SIM terminal response object.

void QSimTerminalResponse::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.

QSimTerminalResponse::Cause QSimTerminalResponse::cause () const

Returns the additional cause information for this SIM terminal response. Returns NoSpecificCause if there is no additional cause information.

The additional cause value is the first byte of causeData(), or NoSpecificCause if causeData() is empty. Thus, cause() should be used only as a convenience function to quickly determine the cause of an error result().

See also setCause(), causeData(), and result().

QByteArray QSimTerminalResponse::causeData () const

Returns the additional cause data associated with this SIM terminal response. The default value is an empty QByteArray.

See also setCauseData(), cause(), and result().

QSimCommand QSimTerminalResponse::command () const

Returns the SIM command that gave rise to this SIM terminal response. The default is a default-constructed QSimCommand.

See also setCommand(), commandPdu(), and setCommandPdu().

QByteArray QSimTerminalResponse::commandPdu () const

Returns the PDU form of the SIM command that gave rise to this SIM terminal response. The default is a PDU corresponding to a default-constructed QSimCommand.

See also setCommandPdu(), command(), and setCommand().

int QSimTerminalResponse::dataCodingScheme () const

Returns the recommended data coding scheme for encoding USSD text strings. The default value is -1, which indicates that the best scheme should be chosen based on the contents of the USSD text string.

QSimCommand::Device QSimTerminalResponse::destinationDevice () const

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

uint QSimTerminalResponse::duration () const

Returns the number of milliseconds for the duration of a poll interval. The default value is zero, indicating that the default duration should be used.

Applies to: PollInterval.

QByteArray QSimTerminalResponse::extensionData () const

Returns the extension data for this terminal response. 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 QSimTerminalResponse::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. As an example, the following code extracts the "answer to reset" information from the response to a PowerOnCard SIM command:

    QSimTerminalResponse resp;
    ...
    QByteArray atr = resp.extensionField(0xA1);

QSimTerminalResponse QSimTerminalResponse::fromPdu ( const QByteArray & pdu ) `[static]`

Returns a SIM terminal response object corresponding to the data in pdu. The data is decoded as described in 3GPP TS 11.14, section 6.8.

uint QSimTerminalResponse::menuItem () const

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

Applies to: SelectItem

QSimTerminalResponse::Result QSimTerminalResponse::result () const

Returns the result code for this SIM terminal response. The default value is Success.

The result code may not be sufficient on its own to determine the cause of a failure. The cause() and causeData() functions provides the additional information.

See also setResult(), cause(), and causeData().

void QSimTerminalResponse::setCause ( QSimTerminalResponse::Cause value )

Sets the additional cause information for this SIM terminal response to value. This is equivalent to calling setCauseData() with a QByteArray containing a single byte, value.

See also cause(), setCauseData(), and result().

void QSimTerminalResponse::setCauseData ( const QByteArray & value )

Sets the additional cause data associated with this SIM terminal response to value.

void QSimTerminalResponse::setCommand ( const QSimCommand & value )

Sets the SIM command that gave rise to this SIM terminal response to value. Calling this function will also affect the result of commandPdu().

See also command(), commandPdu(), and setCommandPdu().

void QSimTerminalResponse::setCommandPdu ( const QByteArray & value )

Sets the PDU form of the SIM command that gave rise to this SIM terminal response to value. Calling this function will also affect the result of command().

See also commandPdu(), command(), and setCommand().

void QSimTerminalResponse::setDataCodingScheme ( int value )

Sets the recommended data coding scheme for encoding USSD text strings to value. The value -1 indicates that the best scheme should be chosen based on the contents of the USSD text string.

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

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

void QSimTerminalResponse::setDuration ( uint value )

Sets the duration of a poll interval to value.

Applies to: PollInterval

void QSimTerminalResponse::setExtensionData ( QByteArray value )

Sets the extension data for this terminal response 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 QSimTerminalResponse::setMenuItem ( uint value )

Sets the menu item to be selected to value.

Applies to: SelectItem

void QSimTerminalResponse::setResult ( QSimTerminalResponse::Result value )

Sets the result code for this SIM terminal response to value.

The result code may not be sufficient on its own to determine the cause of a failure. The setCause() and setCauseData() functions can be used to provide the additional information.

See also result(), setCause(), and setCauseData().

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

Sets the source device that generated the response to value.

void QSimTerminalResponse::setText ( const QString & value )

Sets the text to be sent along with this terminal response to value.

Applies to: GetInkey, GetInput

QSimCommand::Device QSimTerminalResponse::sourceDevice () const

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

QString QSimTerminalResponse::text () const

Returns the text to be sent along with this terminal response.