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.

Property Documentation

altitude

float KWeatherCore::CAPArea::altitude

read

Definition at line 56 of file caparea.h.

ceiling

float KWeatherCore::CAPArea::ceiling

read

Definition at line 57 of file caparea.h.

description

QString KWeatherCore::CAPArea::description

read

Definition at line 55 of file caparea.h.

Constructor & Destructor Documentation

CAPArea()

CAPArea::CAPArea

(

)

Definition at line 26 of file caparea.cpp.

Member Function Documentation

addCircle()

void CAPArea::addCircle

(

CAPCircle &&

circle

)

Definition at line 62 of file caparea.cpp.

addGeoCode()

void CAPArea::addGeoCode

(

CAPNamedValue &&

geoCode

)

Definition at line 72 of file caparea.cpp.

addPolygon()

void CAPArea::addPolygon

(

CAPPolygon &&

polygon

)

Definition at line 52 of file caparea.cpp.

altitude()

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

Definition at line 77 of file caparea.cpp.

ceiling()

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

Definition at line 87 of file caparea.cpp.

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 CAPArea::description

(

)

const

A text description of the message target area.

Definition at line 37 of file caparea.cpp.

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.

setAltitude()

void CAPArea::setAltitude

(

float

altitude

)

Definition at line 82 of file caparea.cpp.

setCeiling()

void CAPArea::setCeiling

(

float

ceiling

)

Definition at line 92 of file caparea.cpp.

setDescription()

void CAPArea::setDescription

(

const QString &

areaDesc

)

Definition at line 42 of file caparea.cpp.

---

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

• caparea.h
• caparea.cpp