KWeatherCore::CAPAlertMessage

Search for usage in LXR

KWeatherCore::CAPAlertMessage Class Reference

#include <capalertmessage.h>

Public Types

enum class  MessageType {
  UnknownMessageType , Alert , Update , Cancel ,
  Acknowledge , Error
}
 
enum class  Scope { UnknownScope , Public , Restricted , Private }
 
enum class  Status {
  UnknownStatus , Actual , Exercise , System ,
  Test , Draft
}
 

Properties

QString identifier
 
MessageType messageType
 
QString note
 
Scope scope
 
QString sender
 
QDateTime sentTime
 
Status status
 

Public Member Functions

 CAPAlertMessage ()
 
 CAPAlertMessage (CAPAlertMessage &&other) noexcept
 
 CAPAlertMessage (const CAPAlertMessage &other)
 
const std::vector< CAPAlertInfo > & alertInfos () const
 
QString identifier () const
 
MessageType messageType () const
 
QString note () const
 
CAPAlertMessageoperator= (CAPAlertMessage &&other) noexcept
 
CAPAlertMessageoperator= (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.

See also
CAPAlertInfo
https://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2.html $3.2.1
Author
Anjani Kumar anjan.nosp@m.ik01.nosp@m.2@gma.nosp@m.il.c.nosp@m.om

Definition at line 28 of file capalertmessage.h.

Member Enumeration Documentation

◆ MessageType

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

Enumerator
Public 

For general dissemination to unrestricted audiences.

Restricted 

For dissemination only to users with a known operational requirement.

Private 

For dissemination only to specified addresses.

Definition at line 58 of file capalertmessage.h.

◆ Status

The code denoting the appropriate handling of the alert message.

Enumerator
Actual 

Actionable by all targeted recipients.

Exercise 

Actionable only by designated exercise participants.

Test 

Technical testing only, all recipients disregard.

Draft 

A preliminary template or draft, not actionable in its current form.

Definition at line 40 of file capalertmessage.h.

Property Documentation

◆ identifier

QString KWeatherCore::CAPAlertMessage::identifier
read

Definition at line 31 of file capalertmessage.h.

◆ messageType

MessageType KWeatherCore::CAPAlertMessage::messageType
read

Definition at line 36 of file capalertmessage.h.

◆ note

QString KWeatherCore::CAPAlertMessage::note
read

Definition at line 34 of file capalertmessage.h.

◆ scope

Scope KWeatherCore::CAPAlertMessage::scope
read

Definition at line 37 of file capalertmessage.h.

◆ sender

QString KWeatherCore::CAPAlertMessage::sender
read

Definition at line 32 of file capalertmessage.h.

◆ sentTime

QDateTime KWeatherCore::CAPAlertMessage::sentTime
read

Definition at line 33 of file capalertmessage.h.

◆ status

Status KWeatherCore::CAPAlertMessage::status
read

Definition at line 35 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.

Definition at line 36 of file capalertmessage.cpp.

◆ messageType()

CAPAlertMessage::MessageType KWeatherCore::CAPAlertMessage::messageType ( ) const

The code denoting the nature of the alert message.

Returns UnknownMsgType if not set.

Definition at line 52 of file capalertmessage.cpp.

◆ note()

QString KWeatherCore::CAPAlertMessage::note ( ) const

The text describing the purpose or significance of the alert message.

Relevant for Exercise and Error status.

Definition at line 60 of file capalertmessage.cpp.

◆ 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()

CAPAlertMessage::Scope KWeatherCore::CAPAlertMessage::scope ( ) const

The code denoting the intended distribution of the alert message.

Returns UnknownScope if not set.

Definition at line 56 of file capalertmessage.cpp.

◆ sender()

QString KWeatherCore::CAPAlertMessage::sender ( ) const

The identifier of the sender of the alert message.

Definition at line 40 of file capalertmessage.cpp.

◆ sentTime()

QDateTime KWeatherCore::CAPAlertMessage::sentTime ( ) const

The time and date of the origination of the alert message.

Definition at line 44 of file capalertmessage.cpp.

◆ status()

CAPAlertMessage::Status KWeatherCore::CAPAlertMessage::status ( ) const

The code denoting the appropriate handling of the alert message.

Returns UnknownStatus if not set.

Definition at line 48 of file capalertmessage.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:56:31 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.