Home · All Classes · Annotated · Functions

QAtResult Class Reference

The QAtResult class provides access to the results of an AT modem command 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 an AT modem command

The QAtResult class provides access to the results of an AT modem command that was executed via the QAtChat class.

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.

QString QAtResult::content () const

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

See also setContent().

bool QAtResult::ok () const

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

QString QAtResult::result () const

Get 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

Get 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().

void QAtResult::setContent ( const QString & value )

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

See also content().

void QAtResult::setResult ( const QString & value )

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

See also result().

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

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

See also resultCode().

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

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

See also userData().

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

Get the user data associated with this result object.

See also setUserData().

QString QAtResult::verboseResult () const

Return 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.

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

Assign the contents of other to this object.