KWeatherCore::CAPAlertInfo

Search for usage in LXR

KWeatherCore::CAPAlertInfo Class Reference

#include <capalertinfo.h>

Public Types

typedef QFlags< Category > Categories
 
enum  Category {
  Unknown = 0, Geophysical = 0b1, Meteorological = 0b10, Safety = 0b100,
  Security = 0b1000, Rescue = 0b10000, Fire = 0b100000, Health = 0b1000000,
  Environmental = 0b10000000, Transport = 0b100000000, Infrastructure = 0b1000000000, CBRNE = 0b10000000000,
  Other = 0b100000000000
}
 
enum  Certainty {
  Observed, Likely, Possible, Unlikely,
  UnknownCertainty
}
 
enum  ResponseType {
  UnknownResponseType = 0, Shelter = 1 << 0, Evacuate = 1 << 1, Prepare = 1 << 2,
  Execute = 1 << 3, Avoid = 1 << 4, Monitor = 1 << 5, Assess = 1 << 6,
  AllClear = 1 << 7, None = 1 << 8
}
 
typedef QFlags< ResponseType > ResponseTypes
 
enum  Severity {
  Extreme, Severe, Moderate, Minor,
  UnknownSeverity
}
 
enum  Urgency {
  Immediate, Expected, Future, Past,
  UnknownUrgency
}
 

Properties

Categories categories
 
Certainty certainty
 
QString contact
 
QString description
 
QDateTime effectiveTime
 
QString event
 
QDateTime expireTime
 
QString headline
 
QString instruction
 
QString language
 
QDateTime onsetTime
 
ResponseTypes responseTypes
 
QString sender
 
Severity severity
 
Urgency urgency
 
QString web
 

Public Member Functions

 CAPAlertInfo (CAPAlertInfo &&other)
 
 CAPAlertInfo (const CAPAlertInfo &other)
 
const std::vector< CAPArea > & areas () const
 
Categories categories () const
 
Certainty certainty () const
 
QString contact () const
 
QString description () const
 
QDateTime effectiveTime () const
 
QString event () const
 
const std::vector< CAPNamedValue > & eventCodes () const
 
QDateTime expireTime () const
 
QString headline () const
 
QString instruction () const
 
QString language () const
 
QDateTime onsetTime () const
 
CAPAlertInfooperator= (CAPAlertInfo &&other)
 
CAPAlertInfooperator= (const CAPAlertInfo &other)
 
const std::vector< CAPNamedValue > & parameters () const
 
ResponseTypes responseTypes () const
 
QString sender () const
 
Severity severity () const
 
Urgency urgency () const
 
QString web () const
 

Detailed Description

Represents a single CAP alert message info element.

See also
CAPAlertMessage
https://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2.html ยง3.2.2
Author
Han Young hanyo.nosp@m.ung@.nosp@m.proto.nosp@m.nmai.nosp@m.l.com
Anjani Kumar anjan.nosp@m.ik01.nosp@m.2@gma.nosp@m.il.c.nosp@m.om

Definition at line 27 of file capalertinfo.h.

Member Function Documentation

◆ areas()

const std::vector< CAPArea > & KWeatherCore::CAPAlertInfo::areas ( ) const

The areas targeted by this CAP alert message.

Definition at line 114 of file capalertinfo.cpp.

◆ categories()

Categories KWeatherCore::CAPAlertInfo::categories ( ) const

The category of the alert message.

Returns
default to Unknown, value is bit or-ed

◆ certainty()

Certainty KWeatherCore::CAPAlertInfo::certainty ( ) const

The certainty of the alert message.

Returns
default to UnknownCertainty

◆ contact()

QString KWeatherCore::CAPAlertInfo::contact ( ) const

Describing the contact for follow-up and confirmation of the alert message.

◆ description()

QString KWeatherCore::CAPAlertInfo::description ( ) const

The description of the alert message.

◆ effectiveTime()

QDateTime KWeatherCore::CAPAlertInfo::effectiveTime ( ) const

The effective time of the information of the alert message.

◆ event()

QString KWeatherCore::CAPAlertInfo::event ( ) const

The text denoting the type of the subject event of the alert message.

◆ eventCodes()

const std::vector< CAPNamedValue > & KWeatherCore::CAPAlertInfo::eventCodes ( ) const

System-specific codes for event typing.

Definition at line 118 of file capalertinfo.cpp.

◆ expireTime()

QDateTime KWeatherCore::CAPAlertInfo::expireTime ( ) const

The expire time of the information of the alert message.

◆ headline()

QString KWeatherCore::CAPAlertInfo::headline ( ) const

The text headline of the alert message.

◆ instruction()

QString KWeatherCore::CAPAlertInfo::instruction ( ) const

The instruction of the alert message.

◆ language()

QString KWeatherCore::CAPAlertInfo::language ( ) const

The code denoting the language of the info default to "en-US".

Returns
Natural language identifier per [RFC 3066].

◆ onsetTime()

QDateTime KWeatherCore::CAPAlertInfo::onsetTime ( ) const

The onset time of the information of the alert message.

◆ parameters()

const std::vector< CAPNamedValue > & KWeatherCore::CAPAlertInfo::parameters ( ) const

The Parameter of the alert message refer to CAP protocol v1.2.

Definition at line 110 of file capalertinfo.cpp.

◆ responseTypes()

ResponseTypes KWeatherCore::CAPAlertInfo::responseTypes ( ) const

Type of action recommended for the target audience of the alert.

◆ sender()

QString KWeatherCore::CAPAlertInfo::sender ( ) const

The sender of the alert message.

◆ severity()

Severity KWeatherCore::CAPAlertInfo::severity ( ) const

The severity of the alert message.

Returns
default to UnknownSeverity

◆ urgency()

Urgency KWeatherCore::CAPAlertInfo::urgency ( ) const

The urgency of the alert message.

Returns
default to UnknownUrgency

◆ web()

QString KWeatherCore::CAPAlertInfo::web ( ) const

Link associating additional information with the alert message.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
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.