KWeatherCore::CAPAlertMessage
#include <capalertmessage.h>
Public Types | |
enum | MessageType { UnknownMessageType, MessageType::Alert, MessageType::Update, MessageType::Cancel, MessageType::Acknowledge, MessageType::Error } |
enum | Scope { UnknownScope, Scope::Public, Scope::Restricted, Scope::Private } |
enum | Status { UnknownStatus, Status::Actual, Status::Exercise, System, Status::Test, Status::Draft } |
Properties | |
QString | identifier |
MessageType | messageType |
QString | note |
Scope | scope |
QString | sender |
QDateTime | sentTime |
Status | status |
Public Member Functions | |
CAPAlertMessage () | |
CAPAlertMessage (CAPAlertMessage &&other) | |
CAPAlertMessage (const CAPAlertMessage &other) | |
const std::vector< CAPAlertInfo > & | alertInfos () const |
QString | identifier () const |
MessageType | messageType () const |
QString | note () const |
CAPAlertMessage & | operator= (CAPAlertMessage &&other) |
CAPAlertMessage & | operator= (const CAPAlertMessage &other) |
CAPReference | ownReference () const |
const std::vector< CAPReference > & | references () const |
Scope | scope () const |
QString | sender () const |
QDateTime | sentTime () const |
Status | status () const |
Detailed Description
Represents a single CAP Alert Message.
This class contains the information of a parsed CAP alert message.
Definition at line 28 of file capalertmessage.h.
Member Enumeration Documentation
◆ MessageType
|
strong |
Enumerator | |
---|---|
Alert | Initial information requiring attention by targeted recipients. |
Update | Updates and supercedes the earlier message(s) identified in references() |
Cancel | Cancels the earlier message(s) identified in references() |
Acknowledge | Acknowledges receipt and acceptance of the message(s) identified in references() |
Error | Indicates rejection of the message(s) identified in references() |
Definition at line 49 of file capalertmessage.h.
◆ Scope
|
strong |
Definition at line 58 of file capalertmessage.h.
◆ Status
|
strong |
The code denoting the appropriate handling of the alert message.
Definition at line 40 of file capalertmessage.h.
Constructor & Destructor Documentation
◆ CAPAlertMessage()
KWeatherCore::CAPAlertMessage::CAPAlertMessage | ( | ) |
Default constructor, Status, MsgType, Scope are set to Unknown.
Definition at line 26 of file capalertmessage.cpp.
Member Function Documentation
◆ alertInfos()
const std::vector< CAPAlertInfo > & KWeatherCore::CAPAlertMessage::alertInfos | ( | ) | const |
The alert info elements of this alert message.
- See also
- CAPAlertInfo
Definition at line 64 of file capalertmessage.cpp.
◆ identifier()
QString KWeatherCore::CAPAlertMessage::identifier | ( | ) | const |
Unique alert message identifier.
◆ messageType()
MessageType KWeatherCore::CAPAlertMessage::messageType | ( | ) | const |
The code denoting the nature of the alert message.
Returns UnknownMsgType if not set.
◆ note()
QString KWeatherCore::CAPAlertMessage::note | ( | ) | const |
The text describing the purpose or significance of the alert message.
Relevant for Exercise and Error status.
◆ ownReference()
CAPReference KWeatherCore::CAPAlertMessage::ownReference | ( | ) | const |
Reference of this CAP alert message.
- See also
- references()
Definition at line 72 of file capalertmessage.cpp.
◆ references()
const std::vector< CAPReference > & KWeatherCore::CAPAlertMessage::references | ( | ) | const |
References to previous CAP alert messages.
Relevant for Update, Cancel and Ack message types.
Definition at line 68 of file capalertmessage.cpp.
◆ scope()
Scope KWeatherCore::CAPAlertMessage::scope | ( | ) | const |
The code denoting the intended distribution of the alert message.
Returns UnknownScope if not set.
◆ sender()
QString KWeatherCore::CAPAlertMessage::sender | ( | ) | const |
The identifier of the sender of the alert message.
◆ sentTime()
QDateTime KWeatherCore::CAPAlertMessage::sentTime | ( | ) | const |
The time and date of the origination of the alert message.
◆ status()
Status KWeatherCore::CAPAlertMessage::status | ( | ) | const |
The code denoting the appropriate handling of the alert message.
Returns UnknownStatus if not set.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Dec 2 2023 03:54:22 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.