KWeatherCore::CAPArea Class Reference

#include <caparea.h>

Properties
float	altitude
float	ceiling
QString	description

Public Member Functions
	CAPArea (CAPArea &&other)
	CAPArea (const CAPArea &other)
void	addCircle (CAPCircle &&circle)
void	addGeoCode (CAPNamedValue &&geoCode)
void	addPolygon (CAPPolygon &&polygon)
float	altitude () const
float	ceiling () const
const std::vector< CAPCircle > &	circles () const
QString	description () const
const std::vector< CAPNamedValue > &	geoCodes () const
CAPArea &	operator= (CAPArea &&other)
CAPArea &	operator= (const CAPArea &other)
const std::vector< CAPPolygon > &	polygons () const
void	setAltitude (float altitude)
void	setCeiling (float ceiling)
void	setDescription (const QString &areaDesc)

Detailed Description

Affected area of a CAP alert message.

See also

https://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2.html §3.2.4

Definition at line 52 of file caparea.h.

Member Function Documentation

altitude()

float KWeatherCore::CAPArea::altitude

(

)

const

The specific or minimum altitude of the affected area of the alert message.

The altitude measure is in feet above mean sea level. If not set, NAN is returned.

ceiling()

float KWeatherCore::CAPArea::ceiling

(

)

const

The maximum altitude of the affected area of the alert message.

The altitude measure is in feet above mean sea level. If not set, NAN is returned.

circles()

const std::vector< CAPCircle > & CAPArea::circles

(

)

const

Geographic circles(s) enclosing the message target area.

Definition at line 57 of file caparea.cpp.

description()

QString KWeatherCore::CAPArea::description

(

)

const

A text description of the message target area.

geoCodes()

const std::vector< CAPNamedValue > & CAPArea::geoCodes

(

)

const

Any geographically-based code to describe a message target area, as key/value pair.

Definition at line 67 of file caparea.cpp.

polygons()

const std::vector< CAPPolygon > & CAPArea::polygons

(

)

const

Geographic polygon(s) enclosing the message target area.

Definition at line 47 of file caparea.cpp.

---

The documentation for this class was generated from the following files:

• caparea.h
• caparea.cpp