KPublicTransport::StopoverRequest

Search for usage in LXR

KPublicTransport::StopoverRequest Class Reference

#include <stopoverrequest.h>

Public Types

enum  Mode { QueryArrival, QueryDeparture }
 

Properties

QStringList backends
 
QDateTime dateTime
 
bool downloadAssets
 
int maximumResults
 
Mode mode
 
KPublicTransport::Location stop
 

Public Member Functions

 StopoverRequest (const Location &stop)
 
QStringList backendIds () const
 
QString cacheKey () const
 
bool isValid () const
 
void setBackendIds (const QStringList &backendIds)
 

Detailed Description

Describes an arrival or departure search.

By default this search departures starting now, from the given Location.

Definition at line 31 of file stopoverrequest.h.

Member Enumeration Documentation

Query departures or arrivals?

Enumerator
QueryArrival 

Search for arrivals.

QueryDeparture 

Search for departures.

Definition at line 44 of file stopoverrequest.h.

Property Documentation

QDateTime StopoverRequest::dateTime
readwrite

Date/time at which the search should start.

Default: now

Definition at line 40 of file stopoverrequest.h.

bool KPublicTransport::StopoverRequest::downloadAssets
readwrite

Enable downloading of graphic assets such as line logos for the data requested here.

Default: false

Definition at line 60 of file stopoverrequest.h.

int KPublicTransport::StopoverRequest::maximumResults
readwrite

The maximum amount of expected results.

Note
This is only an optimization hint for backends, not a guarantee that all results comply with this constraint.

Definition at line 66 of file stopoverrequest.h.

Mode KPublicTransport::StopoverRequest::mode
readwrite

Controls whether to search for arrivals or departures.

Default is QueryDeparture.

Definition at line 53 of file stopoverrequest.h.

KPublicTransport::Location KPublicTransport::StopoverRequest::stop
readwrite

The location at which to search for departures/arrivals.

Definition at line 36 of file stopoverrequest.h.

Constructor & Destructor Documentation

StopoverRequest::StopoverRequest ( const Location stop)
explicit

Search for arrival/departures to/from stop.

Definition at line 41 of file stopoverrequest.cpp.

Member Function Documentation

QStringList StopoverRequest::backendIds ( ) const

Identifiers of the backends that should be queried.

See also
setBackendIds()

Definition at line 106 of file stopoverrequest.cpp.

QString StopoverRequest::cacheKey ( ) const

Unique string representation used for caching results.

Definition at line 117 of file stopoverrequest.cpp.

bool StopoverRequest::isValid ( ) const

Returns true if this is a valid request, ie.

this is complete enough to perform a query.

Definition at line 47 of file stopoverrequest.cpp.

void StopoverRequest::setBackendIds ( const QStringList backendIds)

Set identifiers of backends that should be queried.

Settings this is only needed when you want explicit control over this, leaving this empty picks suitable backends automatically.

Definition at line 111 of file stopoverrequest.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.