KPublicTransport::OnboardStatus

Search for usage in LXR

KPublicTransport::OnboardStatus Class Reference

#include <onboardstatus.h>

Inheritance diagram for KPublicTransport::OnboardStatus:

Public Types

enum  Status {
  NotConnected, Onboard, MissingPermissions, WifiNotEnabled,
  LocationServiceNotEnabled, NotAvailable
}
 

Properties

float altitude
 
bool hasAltitude
 
bool hasHeading
 
bool hasJourney
 
bool hasPosition
 
bool hasSpeed
 
float heading
 
KPublicTransport::Journey journey
 
int journeyUpdateInterval
 
float latitude
 
float longitude
 
int positionUpdateInterval
 
float speed
 
Status status
 
bool supportsJourney
 
bool supportsPosition
 
- Properties inherited from QObject
 objectName
 

Signals

void journeyChanged ()
 
void positionChanged ()
 
void statusChanged ()
 
void supportsJourneyChanged ()
 
void supportsPositionChanged ()
 
void updateIntervalChanged ()
 

Public Member Functions

 OnboardStatus (QObject *parent=nullptr)
 
float altitude () const
 
bool hasAltitude () const
 
bool hasHeading () const
 
bool hasJourney () const
 
bool hasPosition () const
 
bool hasSpeed () const
 
float heading () const
 
KPublicTransport::Journey journey () const
 
int journeyUpdateInterval () const
 
float latitude () const
 
float longitude () const
 
int positionUpdateInterval () const
 
Q_INVOKABLE void requestJourney ()
 
Q_INVOKABLE void requestPermissions ()
 
Q_INVOKABLE void requestPosition ()
 
void setJourneyUpdateInterval (int interval)
 
void setPositionUpdateInterval (int interval)
 
float speed () const
 
Status status () const
 
bool supportsJourney () const
 
bool supportsPosition () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Access to public transport onboard API.

Instances of this class act as a lightweight frontend to an internal singleton, for easy integration with QML.

Definition at line 24 of file onboardstatus.h.

Member Enumeration Documentation

◆ Status

Enumerator
NotConnected 

Wi-Fi monitoring functional, but currently not connected to an onboard Wi-Fi.

Onboard 

currently connected to a known onboard Wi-Fi system.

MissingPermissions 

Wi-Fi monitoring not functional due to missing application permissions.

WifiNotEnabled 

Wi-Fi monitoring is not possible due to Wi-Fi being disabled.

LocationServiceNotEnabled 

Wi-Fi monitoring is not possible due to the location service being disabled (Android only).

NotAvailable 

Wi-Fi monitoring is generally not available on this platform.

Definition at line 64 of file onboardstatus.h.

Property Documentation

◆ altitude

float OnboardStatus::altitude
read

Current altitude in meters, NAN if unknown.

Definition at line 46 of file onboardstatus.h.

◆ hasJourney

bool OnboardStatus::hasJourney
read

Whether there is journey information available.

Definition at line 52 of file onboardstatus.h.

◆ hasPosition

bool OnboardStatus::hasPosition
read

Whether the geographic position is currently available.

Definition at line 33 of file onboardstatus.h.

◆ heading

float OnboardStatus::heading
read

Current heading in degree, NAN if unknown.

Definition at line 42 of file onboardstatus.h.

◆ journey

Journey OnboardStatus::journey
read

The current journey.

Definition at line 50 of file onboardstatus.h.

◆ latitude

float OnboardStatus::latitude
read

Current geographic position, NAN if not available.

Definition at line 30 of file onboardstatus.h.

◆ positionUpdateInterval

int OnboardStatus::positionUpdateInterval
readwrite

Update polling intervals in seconds.

Definition at line 57 of file onboardstatus.h.

◆ speed

float OnboardStatus::speed
read

Current speed in km/h.

Definition at line 38 of file onboardstatus.h.

◆ supportsJourney

bool OnboardStatus::supportsJourney
read

Whether the backend supports querying for the journey.

Definition at line 54 of file onboardstatus.h.

◆ supportsPosition

bool OnboardStatus::supportsPosition
read

Whether the backend supports querying for the geographic position.

Definition at line 35 of file onboardstatus.h.

Member Function Documentation

◆ requestJourney()

void OnboardStatus::requestJourney ( )

Request one time journey data update, if available.

For recurring updates, use the polling interval setting instead.

Definition at line 147 of file onboardstatus.cpp.

◆ requestPermissions()

void OnboardStatus::requestPermissions ( )

Request application permission needed for Wi-Fi montioring.

Only relevant on Android, does nothing on other platforms.

See also
Status::MissingPermissions

Definition at line 152 of file onboardstatus.cpp.

◆ requestPosition()

void OnboardStatus::requestPosition ( )

Request one time update of the position status.

For recurring updates, use the polling interval setting instead.

Definition at line 142 of file onboardstatus.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 Thu Feb 15 2024 03:58:41 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.