Search for usage in LXR

#include <coveragearea.h>

Public Types

enum  Type { Realtime , Regular , Any }


QStringList regions
Type type
QStringList uicCompanyCodes
QStringList vdvOrganizationIds

Public Member Functions

bool coversLocation (const Location &loc) const
bool hasNationWideCoverage (const QString &country) 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 21 of file coveragearea.h.

Member Enumeration Documentation

◆ Type

Coverage quality as defined by the Transport API Repository format.

Definition at line 26 of file coveragearea.h.

Property Documentation

◆ regions

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.

◆ type

Type KPublicTransport::CoverageArea::type

Definition at line 32 of file coveragearea.h.

◆ uicCompanyCodes

QStringList KPublicTransport::CoverageArea::uicCompanyCodes

UIC company codes of operators covered by this backend.

Definition at line 40 of file coveragearea.h.

◆ vdvOrganizationIds

QStringList KPublicTransport::CoverageArea::vdvOrganizationIds

VDV organization ids of operators covered by this backend.

Definition at line 42 of file coveragearea.h.

Member Function Documentation

◆ coversLocation()

bool CoverageArea::coversLocation ( const Location & loc) const

Checks whether loc is covered by this area.

Definition at line 86 of file coveragearea.cpp.

◆ fromJson()

CoverageArea CoverageArea::fromJson ( const QJsonObject & obj)

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

Definition at line 120 of file coveragearea.cpp.

◆ hasNationWideCoverage()

bool CoverageArea::hasNationWideCoverage ( const QString & country) const

Checks whether this includes the entire country country.

Definition at line 115 of file coveragearea.cpp.

◆ isEmpty()

bool CoverageArea::isEmpty ( ) const

Checks whether this coverage area is empty.

coversLocation() would always return false for empty areas.

Definition at line 67 of file coveragearea.cpp.

◆ isGlobal()

bool CoverageArea::isGlobal ( ) const

Returns true if this area covers the entire world.

Definition at line 72 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-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:13:06 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.