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

QCBSMessage Class Reference
[QtTelephonyModule]

The QCBSMessage class specifies the contents of a cell broadcast message. More...

    #include <QCBSMessage>

List of all members, including inherited members

Public Types

enum GeographicalScope { CellWide, PLMNWide, LocationAreaWide, CellWide2 }
enum Language { German, English, Italian, French, ..., Unspecified }

Public Functions

QCBSMessage ()
QCBSMessage ( const QCBSMessage & msg )
~QCBSMessage ()
uint channel () const
QCBSMessage::Language language () const
uint messageCode () const
uint numPages () const
uint page () const
QCBSMessage::GeographicalScope scope () const
void setChannel ( uint chan )
void setLanguage ( QCBSMessage::Language lang )
void setMessageCode ( uint num )
void setNumPages ( uint npages )
void setPage ( uint page )
void setScope ( QCBSMessage::GeographicalScope scope )
void setText ( const QString & str )
void setUpdateNumber ( uint num )
QString text () const
QByteArray toPdu () const
uint updateNumber () const
bool operator!= ( const QCBSMessage & other ) const
QCBSMessage & operator= ( const QCBSMessage & msg )
bool operator== ( const QCBSMessage & other ) const

Static Public Members

QCBSMessage fromPdu ( const QByteArray & pdu )

Detailed Description

The QCBSMessage class specifies the contents of a cell broadcast message.

Cell broadcast messages arrive asynchronously from the network and are delivered to applications via the QCellBroadcast::broadcast() signal. The most common use of cell broadcast messages is to display cell location information.

Cell broadcast messages are uniquely identified by a combination of scope(), messageCode(), and updateNumber(). Together with the cell identifier, QNetworkRegistration::cellId(), and the location area code, QNetworkRegistration::locationAreaCode(), client applications can determine if a message is new, or a repetition of an existing message.

See also QCellBroadcast and QNetworkRegistration.

Member Type Documentation

enum QCBSMessage::GeographicalScope

Describes the geographical scope of a cell broadcast message, which is used to help determine if a cell broadcast message is new.

Constant	Value	Description
`QCBSMessage::CellWide`	`0`	The message is specific to the current cell. If a message arrives with the same messageCode() and updateNumber() as an existing message, but QNetworkRegistration::cellId() has changed, then the message is new rather than a repetition. Messages with the `CellWide` scope should be displayed immediately if possible.
`QCBSMessage::PLMNWide`	`1`	The message is specific to the network operator, regardless of cell.
`QCBSMessage::LocationAreaWide`	`2`	The message is specific to the location area. If a message arrives with the same messageCode() and updateNumber() as an existing message, but the QNetworkRegistration::locationAreaCode() has changed, then the message is new rather than a repetition.
`QCBSMessage::CellWide2`	`3`	Same as `CellWide`, but the message does not need to be displayed immediately.

enum QCBSMessage::Language

Describes the language that a cell broadcast message is written in.

Constant	Value	Description
`QCBSMessage::German`	`0`	The message is written in German.
`QCBSMessage::English`	`1`	The message is written in English.
`QCBSMessage::Italian`	`2`	The message is written in Italian.
`QCBSMessage::French`	`3`	The message is written in French.
`QCBSMessage::Spanish`	`4`	The message is written in Spanish.
`QCBSMessage::Dutch`	`5`	The message is written in Dutch.
`QCBSMessage::Swedish`	`6`	The message is written in Swedish.
`QCBSMessage::Danish`	`7`	The message is written in Danish.
`QCBSMessage::Portuguese`	`8`	The message is written in Portuguese.
`QCBSMessage::Finnish`	`9`	The message is written in Finnish.
`QCBSMessage::Norwegian`	`10`	The message is written in Norwegian.
`QCBSMessage::Greek`	`11`	The message is written in Greek.
`QCBSMessage::Turkish`	`12`	The message is written in Turkish.
`QCBSMessage::Hungarian`	`13`	The message is written in Hungarian.
`QCBSMessage::Polish`	`14`	The message is written in Polish.
`QCBSMessage::Unspecified`	`15`	The language that the message is written in is unspecified.

Member Function Documentation

QCBSMessage::QCBSMessage ()

Constructs an empty QCBSMessage.

QCBSMessage::QCBSMessage ( const QCBSMessage & msg )

Constructs a copy of msg.

QCBSMessage::~QCBSMessage ()

Destructs the QCBSMessage.

uint QCBSMessage::channel () const

Returns the channel number for this cell broadcast message. The most common channel number is 50, indicating cell location information.

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

Convert a binary pdu into a CBS message, according to 3GPP TS 03.41 and 3GPP TS 23.041.

QCBSMessage::Language QCBSMessage::language () const

Returns the language that this cell broadcast message is expressed in. This can allow applications to distinguish between multiple copies of the same information in different languages.

uint QCBSMessage::messageCode () const

Returns the cell broadcast message code.

uint QCBSMessage::numPages () const

Returns the number of pages that make up this cell broadcast message.

uint QCBSMessage::page () const

Returns the page number for this cell broadcast message if the information that it contains is split over multiple pages.

QCBSMessage::GeographicalScope QCBSMessage::scope () const

Returns the geographical scope of the message.

void QCBSMessage::setChannel ( uint chan )

Sets the channel number for this cell broadcast message to chan.

void QCBSMessage::setLanguage ( QCBSMessage::Language lang )

Sets the language that this cell broadcast message is expressed in to lang.

void QCBSMessage::setMessageCode ( uint num )

Sets the cell broadcast message code to num.

void QCBSMessage::setNumPages ( uint npages )

Sets the number of pages in this cell broadcast message to npages.

void QCBSMessage::setPage ( uint page )

Sets the page number for this cell broadcast message to page.

void QCBSMessage::setScope ( QCBSMessage::GeographicalScope scope )

Sets the geographical scope of the message to scope.

void QCBSMessage::setText ( const QString & str )

Sets the text that is contained in this cell broadcast message to str.

void QCBSMessage::setUpdateNumber ( uint num )

Sets the update number for this cell broadcast message to num.

QString QCBSMessage::text () const

Returns the text that is contained in this cell broadcast message.

QByteArray QCBSMessage::toPdu () const

Convert this CBS message into its binary PDU form, according to 3GPP TS 03.41 and 3GPP TS 23.041.

uint QCBSMessage::updateNumber () const

Returns the update number for this cell broadcast message.

bool QCBSMessage::operator!= ( const QCBSMessage & other ) const

Returns true if this cell broadcast message object is equal to other; otherwise returns false.

QCBSMessage & QCBSMessage::operator= ( const QCBSMessage & msg )

Assigns a copy of msg to this object.

bool QCBSMessage::operator== ( const QCBSMessage & other ) const