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

QAtResult Class Reference
[QtBaseModule]

The QAtResult class provides access to the results of AT modem commands and unsolicited notifications More...

    #include <QAtResult>

• List of all members, including inherited members

Public Types

• class UserData
• enum ResultCode { OK, Connect, NoCarrier, Error, ..., UnknownError }

Public Functions

• QAtResult ()
• QAtResult ( const QAtResult & other )
• ~QAtResult ()
• void append ( const QString & value )
• QString content () const
• bool ok () const
• QString result () const
• QAtResult::ResultCode resultCode () const
• void setContent ( const QString & value )
• void setResult ( const QString & value )
• void setResultCode ( QAtResult::ResultCode value )
• void setUserData ( QAtResult::UserData * value )
• QAtResult::UserData * userData () const
• QString verboseResult () const
• QAtResult & operator= ( const QAtResult & other )

Detailed Description

The QAtResult class provides access to the results of AT modem commands and unsolicited notifications

AT commands that are sent to a modem with QAtChat::chat() result in a QAtResult object being made available to describe the result of the command when it completes.

The resultCode() method can be used to determine the exact cause of an AT modem command failure. The content() method can be used to access the response content that was returned from the command. For complex response contents, the QAtResultParser class can be used to decode the response.

See also QAtChat and QAtResultParser.

Member Type Documentation

enum QAtResult::ResultCode

Result codes for AT modem commands.

Member Function Documentation

QAtResult::QAtResult ()

Construct a new QAtResult object. The result() will be OK, and the content() empty.

QAtResult::QAtResult ( const QAtResult & other )

Construct a copy of other.

QAtResult::~QAtResult ()

Destruct this QAtResult object.

void QAtResult::append ( const QString & value )

Append value to the current content, after a line terminator.

See also content() and setContent().

QString QAtResult::content () const

Returns the content that was returned with an AT command's result.

See also setContent() and append().

bool QAtResult::ok () const

Returns true if this result indicates a successful command; false otherwise. Success is indicated when resultCode() returns either QAtResult::OK or QAtResult::Connect. All other result codes indicate failure.

See also resultCode().

QString QAtResult::result () const

Returns the result line that terminated the command's response. This is usually a string such as OK, ERROR, +CME ERROR: N, and so on.

The resultCode() function is a better way to determine why a command failed, but sometimes it is necessary to parse the text result line. For example, for CONNECT baudrate, the caller may be interested in the baud rate.

See also setResult(), resultCode(), and ok().

QAtResult::ResultCode QAtResult::resultCode () const

Returns the numeric result code associated with result().

Extended error codes are only possible if the appropriate modem error mode has been enabled (e.g. with the AT+CMEE=1 command). Otherwise most errors will simply be reported as QAtResult::Error.

See also setResultCode(), result(), and ok().

void QAtResult::setContent ( const QString & value )

Sets the content that was returned with an AT command's result to value.

See also content() and append().

void QAtResult::setResult ( const QString & value )

Sets the result line that terminated the command's response to value. This will also update resultCode() to reflect the appropriate code.

See also result() and resultCode().

void QAtResult::setResultCode ( QAtResult::ResultCode value )

Sets the numeric result code to value, and update result() to reflect the value.

See also resultCode() and result().

void QAtResult::setUserData ( QAtResult::UserData * value )

Sets the user data associated with this result object to value.

See also userData().

QAtResult::UserData * QAtResult::userData () const

Returns the user data associated with this result object.

See also setUserData().

QString QAtResult::verboseResult () const

Returns a more verbose version of result(), suitable for debug output. Many modems report extended errors by number (e.g. +CME ERROR: 4), which can be difficult to use when diagnosing problems. This function returns a string that is more suitable for diagnostic output than result(). If result() is already verbose, it will be returned as-is.

See also result().

QAtResult & QAtResult::operator= ( const QAtResult & other )

Assign the contents of other to this object.