KPublicTransport::Journey

Search for usage in LXR

#include <journey.h>

Properties

int arrivalDelay
 
int departureDelay
 
KPublicTransport::Disruption::Effect disruptionEffect
 
int duration
 
QDateTime expectedArrivalTime
 
QDateTime expectedDepartureTime
 
bool hasExpectedArrivalTime
 
bool hasExpectedDepartureTime
 
int numberOfChanges
 
QDateTime scheduledArrivalTime
 
QDateTime scheduledDepartureTime
 
QVariantList sections
 

Public Member Functions

void applyMetaData (bool download)
 
int arrivalDelay () const
 
int departureDelay () const
 
Disruption::Effect disruptionEffect () const
 
int duration () const
 
QDateTime expectedArrivalTime () const
 
QDateTime expectedDepartureTime () const
 
bool hasExpectedArrivalTime () const
 
bool hasExpectedDepartureTime () const
 
int numberOfChanges () const
 
QDateTime scheduledArrivalTime () const
 
QDateTime scheduledDepartureTime () const
 
const std::vector< JourneySection > & sections () const
 
void setSections (std::vector< JourneySection > &&sections)
 
std::vector< JourneySection > && takeSections ()
 

Static Public Member Functions

static std::vector< JourneyfromJson (const QJsonArray &array)
 
static Journey fromJson (const QJsonObject &obj)
 
static bool isSame (const Journey &lhs, const Journey &rhs)
 
static Journey merge (const Journey &lhs, const Journey &rhs)
 
static QJsonObject toJson (const Journey &journey)
 
static QJsonArray toJson (const std::vector< Journey > &journeys)
 

Detailed Description

A journey plan.

Definition at line 245 of file journey.h.

Property Documentation

◆ arrivalDelay

int KPublicTransport::Journey::arrivalDelay
read

Difference to schedule in minutes.

Definition at line 270 of file journey.h.

◆ departureDelay

int KPublicTransport::Journey::departureDelay
read

Difference to schedule in minutes.

Definition at line 259 of file journey.h.

◆ disruptionEffect

KPublicTransport::Disruption::Effect KPublicTransport::Journey::disruptionEffect
read

Worst disruption effect of any of the journey sections.

Definition at line 277 of file journey.h.

◆ duration

int KPublicTransport::Journey::duration
read

Duration of the entire journey in seconds.

Definition at line 273 of file journey.h.

◆ expectedArrivalTime

QDateTime KPublicTransport::Journey::expectedArrivalTime
read

Actual arrival time, if available.

Set to invalid to indicate real-time data is not available.

Definition at line 268 of file journey.h.

◆ expectedDepartureTime

QDateTime KPublicTransport::Journey::expectedDepartureTime
read

Actual departure time, if available.

Set to invalid to indicate real-time data is not available.

Definition at line 257 of file journey.h.

◆ hasExpectedArrivalTime

bool KPublicTransport::Journey::hasExpectedArrivalTime
read

true if this has real-time data.

Definition at line 264 of file journey.h.

◆ hasExpectedDepartureTime

bool KPublicTransport::Journey::hasExpectedDepartureTime
read

true if this has real-time data.

Definition at line 253 of file journey.h.

◆ numberOfChanges

int KPublicTransport::Journey::numberOfChanges
read

Number of changes on this journey.

Definition at line 275 of file journey.h.

◆ scheduledArrivalTime

QDateTime KPublicTransport::Journey::scheduledArrivalTime
read

Arrival time of the journey, according to schedule.

Definition at line 262 of file journey.h.

◆ scheduledDepartureTime

QDateTime KPublicTransport::Journey::scheduledDepartureTime
read

Departure time of the journey, according to schedule.

Definition at line 251 of file journey.h.

◆ sections

QVariantList KPublicTransport::Journey::sections
read

Journey sections for consumption by QML.

Definition at line 249 of file journey.h.

Member Function Documentation

◆ applyMetaData()

void Journey::applyMetaData ( bool download)

Augment line meta data.

Parameters
downloadif set to true, trigger the download of locally missing assets.

Definition at line 660 of file journey.cpp.

◆ arrivalDelay()

int Journey::arrivalDelay ( ) const

Definition at line 636 of file journey.cpp.

◆ departureDelay()

int Journey::departureDelay ( ) const

Definition at line 613 of file journey.cpp.

◆ disruptionEffect()

Disruption::Effect Journey::disruptionEffect ( ) const

Definition at line 651 of file journey.cpp.

◆ duration()

int Journey::duration ( ) const

Definition at line 641 of file journey.cpp.

◆ expectedArrivalTime()

QDateTime Journey::expectedArrivalTime ( ) const

Definition at line 631 of file journey.cpp.

◆ expectedDepartureTime()

QDateTime Journey::expectedDepartureTime ( ) const

Definition at line 608 of file journey.cpp.

◆ fromJson() [1/2]

std::vector< Journey > Journey::fromJson ( const QJsonArray & array)
static

Deserialize a list of journey from JSON.

Definition at line 755 of file journey.cpp.

◆ fromJson() [2/2]

Journey Journey::fromJson ( const QJsonObject & obj)
static

Deserialize an object from JSON.

Definition at line 748 of file journey.cpp.

◆ hasExpectedArrivalTime()

bool Journey::hasExpectedArrivalTime ( ) const

Definition at line 626 of file journey.cpp.

◆ hasExpectedDepartureTime()

bool Journey::hasExpectedDepartureTime ( ) const

Definition at line 603 of file journey.cpp.

◆ isSame()

bool Journey::isSame ( const Journey & lhs,
const Journey & rhs )
static

Checks if two instances refer to the same journey (which does not necessarily mean they are exactly equal).

Definition at line 674 of file journey.cpp.

◆ merge()

Journey Journey::merge ( const Journey & lhs,
const Journey & rhs )
static

Merge two instances.

This assumes isSame(lhs, rhs) and tries to preserve the most detailed information.

Definition at line 706 of file journey.cpp.

◆ numberOfChanges()

int Journey::numberOfChanges ( ) const

Definition at line 646 of file journey.cpp.

◆ scheduledArrivalTime()

QDateTime Journey::scheduledArrivalTime ( ) const

Definition at line 618 of file journey.cpp.

◆ scheduledDepartureTime()

QDateTime Journey::scheduledDepartureTime ( ) const

Definition at line 595 of file journey.cpp.

◆ sections()

const std::vector< JourneySection > & Journey::sections ( ) const

The journey sections.

Definition at line 570 of file journey.cpp.

◆ setSections()

void Journey::setSections ( std::vector< JourneySection > && sections)

Sets the journey sections.

Definition at line 581 of file journey.cpp.

◆ takeSections()

std::vector< JourneySection > && Journey::takeSections ( )

Moves the journey sections out of this object.

Definition at line 575 of file journey.cpp.

◆ toJson() [1/2]

QJsonObject Journey::toJson ( const Journey & journey)
static

Serializes one journey object to JSON.

Definition at line 736 of file journey.cpp.

◆ toJson() [2/2]

QJsonArray Journey::toJson ( const std::vector< Journey > & journeys)
static

Serializes a vector of journey objects to JSON.

Definition at line 743 of file journey.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.