KWeatherCore::CAPAlertInfo

Search for usage in LXR

Public Types | Properties | Public Member Functions | List of all members
KWeatherCore::CAPAlertInfo Class Reference

#include <capalertinfo.h>

Public Types

typedef QFlags< Category > Categories
 
enum class  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 class  Certainty {
  Observed , Likely , Possible , Unlikely ,
  UnknownCertainty
}
 
enum class  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 class  Severity {
  Extreme , Severe , Moderate , Minor ,
  UnknownSeverity
}
 
enum class  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) noexcept
 
 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
 
CAPAlertInfo & operator= (CAPAlertInfo &&other) noexcept
 
CAPAlertInfo & operator= (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 Typedef Documentation

◆ Categories

QFlags< Category > KWeatherCore::CAPAlertInfo::Categories

Definition at line 63 of file capalertinfo.h.

◆ ResponseTypes

QFlags< ResponseType > KWeatherCore::CAPAlertInfo::ResponseTypes

Definition at line 84 of file capalertinfo.h.

Member Enumeration Documentation

◆ Category

enum class KWeatherCore::CAPAlertInfo::Category
strong

Definition at line 48 of file capalertinfo.h.

◆ Certainty

enum class KWeatherCore::CAPAlertInfo::Certainty
strong

Definition at line 69 of file capalertinfo.h.

◆ ResponseType

enum class KWeatherCore::CAPAlertInfo::ResponseType
strong

Definition at line 72 of file capalertinfo.h.

◆ Severity

enum class KWeatherCore::CAPAlertInfo::Severity
strong

Definition at line 67 of file capalertinfo.h.

◆ Urgency

enum class KWeatherCore::CAPAlertInfo::Urgency
strong

Definition at line 65 of file capalertinfo.h.

Property Documentation

◆ categories

Categories KWeatherCore::CAPAlertInfo::categories
read

Definition at line 36 of file capalertinfo.h.

◆ certainty

Certainty KWeatherCore::CAPAlertInfo::certainty
read

Definition at line 39 of file capalertinfo.h.

◆ contact

QString KWeatherCore::CAPAlertInfo::contact
read

Definition at line 44 of file capalertinfo.h.

◆ description

QString KWeatherCore::CAPAlertInfo::description
read

Definition at line 31 of file capalertinfo.h.

◆ effectiveTime

QDateTime KWeatherCore::CAPAlertInfo::effectiveTime
read

Definition at line 33 of file capalertinfo.h.

◆ event

QString KWeatherCore::CAPAlertInfo::event
read

Definition at line 32 of file capalertinfo.h.

◆ expireTime

QDateTime KWeatherCore::CAPAlertInfo::expireTime
read

Definition at line 35 of file capalertinfo.h.

◆ headline

QString KWeatherCore::CAPAlertInfo::headline
read

Definition at line 30 of file capalertinfo.h.

◆ instruction

QString KWeatherCore::CAPAlertInfo::instruction
read

Definition at line 41 of file capalertinfo.h.

◆ language

QString KWeatherCore::CAPAlertInfo::language
read

Definition at line 42 of file capalertinfo.h.

◆ onsetTime

QDateTime KWeatherCore::CAPAlertInfo::onsetTime
read

Definition at line 34 of file capalertinfo.h.

◆ responseTypes

ResponseTypes KWeatherCore::CAPAlertInfo::responseTypes
read

Definition at line 43 of file capalertinfo.h.

◆ sender

QString KWeatherCore::CAPAlertInfo::sender
read

Definition at line 40 of file capalertinfo.h.

◆ severity

Severity KWeatherCore::CAPAlertInfo::severity
read

Definition at line 38 of file capalertinfo.h.

◆ urgency

Urgency KWeatherCore::CAPAlertInfo::urgency
read

Definition at line 37 of file capalertinfo.h.

◆ web

QString KWeatherCore::CAPAlertInfo::web
read

Definition at line 45 of file capalertinfo.h.

Constructor & Destructor Documentation

◆ CAPAlertInfo()

KWeatherCore::CAPAlertInfo::CAPAlertInfo ( )

Definition at line 36 of file capalertinfo.cpp.

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

CAPAlertInfo::Categories KWeatherCore::CAPAlertInfo::categories ( ) const

The category of the alert message.

Returns
default to Unknown, value is bit or-ed

Definition at line 62 of file capalertinfo.cpp.

◆ certainty()

CAPAlertInfo::Certainty KWeatherCore::CAPAlertInfo::certainty ( ) const

The certainty of the alert message.

Returns
default to UnknownCertainty

Definition at line 94 of file capalertinfo.cpp.

◆ contact()

QString KWeatherCore::CAPAlertInfo::contact ( ) const

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

Definition at line 102 of file capalertinfo.cpp.

◆ description()

QString KWeatherCore::CAPAlertInfo::description ( ) const

The description of the alert message.

Definition at line 70 of file capalertinfo.cpp.

◆ effectiveTime()

QDateTime KWeatherCore::CAPAlertInfo::effectiveTime ( ) const

The effective time of the information of the alert message.

Definition at line 50 of file capalertinfo.cpp.

◆ event()

QString KWeatherCore::CAPAlertInfo::event ( ) const

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

Definition at line 46 of file capalertinfo.cpp.

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

Definition at line 58 of file capalertinfo.cpp.

◆ headline()

QString KWeatherCore::CAPAlertInfo::headline ( ) const

The text headline of the alert message.

Definition at line 66 of file capalertinfo.cpp.

◆ instruction()

QString KWeatherCore::CAPAlertInfo::instruction ( ) const

The instruction of the alert message.

Definition at line 74 of file capalertinfo.cpp.

◆ 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].

Definition at line 82 of file capalertinfo.cpp.

◆ onsetTime()

QDateTime KWeatherCore::CAPAlertInfo::onsetTime ( ) const

The onset time of the information of the alert message.

Definition at line 54 of file capalertinfo.cpp.

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

CAPAlertInfo::ResponseTypes KWeatherCore::CAPAlertInfo::responseTypes ( ) const

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

Definition at line 98 of file capalertinfo.cpp.

◆ sender()

QString KWeatherCore::CAPAlertInfo::sender ( ) const

The sender of the alert message.

Definition at line 78 of file capalertinfo.cpp.

◆ severity()

CAPAlertInfo::Severity KWeatherCore::CAPAlertInfo::severity ( ) const

The severity of the alert message.

Returns
default to UnknownSeverity

Definition at line 90 of file capalertinfo.cpp.

◆ urgency()

CAPAlertInfo::Urgency KWeatherCore::CAPAlertInfo::urgency ( ) const

The urgency of the alert message.

Returns
default to UnknownUrgency

Definition at line 86 of file capalertinfo.cpp.

◆ web()

QString KWeatherCore::CAPAlertInfo::web ( ) const

Link associating additional information with the alert message.

Definition at line 106 of file capalertinfo.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 Dec 20 2024 12:00:07 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.