Search for usage in LXR

#include <coveragearea.h>

Public Types

enum  Type { Realtime, Regular, Any }


QStringList regions
Type type
QStringList uicCompanyCodes

Public Member Functions

bool coversLocation (const Location &loc) const
bool isEmpty () const
bool isGlobal () const

Static Public Member Functions

static CoverageArea fromJson (const QJsonObject &obj)

Detailed Description

Describes the area a specific KPublicTransport::Backend can provide information for.

Definition at line 22 of file coveragearea.h.

Member Enumeration Documentation

Coverage quality as defined by the Transport API Repository format.

Definition at line 27 of file coveragearea.h.

Property Documentation

QStringList KPublicTransport::CoverageArea::regions

ISO 3166-1/2 codes of covered regions.

Note that actual coverage might be small (e.g. just a city inside the given region).

Definition at line 37 of file coveragearea.h.

QStringList KPublicTransport::CoverageArea::uicCompanyCodes

UIC company codes of operators covered by this backend.

Definition at line 40 of file coveragearea.h.

Member Function Documentation

bool CoverageArea::coversLocation ( const Location loc) const

Checks whether loc is covered by this area.

Definition at line 54 of file coveragearea.cpp.

CoverageArea CoverageArea::fromJson ( const QJsonObject obj)

Read a single coverage area information from a JSON object in Transport API Repository format.

Definition at line 80 of file coveragearea.cpp.

bool CoverageArea::isEmpty ( ) const

Checks whether this coverage area is empty.

coversLocation() would always return false for empty areas.

Definition at line 35 of file coveragearea.cpp.

bool CoverageArea::isGlobal ( ) const

Returns true if this area covers the entire world.

Definition at line 40 of file coveragearea.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Oct 16 2021 23:07:08 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.