Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource Class Reference
Inheritance diagram for QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource:
Collaboration diagram for QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource:

Public Member Functions

 QOhosGeoSatelliteInfoSource (QObject *parent)
 ~QOhosGeoSatelliteInfoSource () override
void setUpdateInterval (int msec) override
int minimumUpdateInterval () const override
Error error () const override
 Returns the last error that occurred.
void startUpdates () override
 Starts emitting updates at regular intervals.
void stopUpdates () override
 Stops emitting updates at regular intervals.
void requestUpdate (int timeout) override
 Attempts to get the current satellite information and emit satellitesInViewUpdated() and satellitesInUseUpdated() with this information.
 QOhosGeoSatelliteInfoSource (QObject *parent)
 ~QOhosGeoSatelliteInfoSource () override
void setUpdateInterval (int msec) override
int minimumUpdateInterval () const override
Error error () const override
 Returns the last error that occurred.
void startUpdates () override
 Starts emitting updates at regular intervals.
void stopUpdates () override
 Stops emitting updates at regular intervals.
void requestUpdate (int timeout) override
 Attempts to get the current satellite information and emit satellitesInViewUpdated() and satellitesInUseUpdated() with this information.
Public Member Functions inherited from QGeoSatelliteInfoSource
 QGeoSatelliteInfoSource (QObject *parent)
 Creates a satellite source with the specified parent.
virtual ~QGeoSatelliteInfoSource ()
 Destroys the satellite source.
QString sourceName () const
 Returns the unique name of the satellite source implementation in use.
int updateInterval () const
QBindable< int > bindableUpdateInterval ()
virtual bool setBackendProperty (const QString &name, const QVariant &value)
virtual QVariant backendProperty (const QString &name) const
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString > bindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlExposed () const noexcept
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread * thread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList & children () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArray > dynamicPropertyNames () const
QBindingStorage * bindingStorage ()
const QBindingStorage * bindingStorage () const
QObject * parent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Additional Inherited Members

Public Types inherited from QGeoSatelliteInfoSource
enum  Error {
  AccessError = 0 , ClosedError = 1 , NoError = 2 , UnknownSourceError = -1 ,
  UpdateTimeoutError = 3
}
 The Error enumeration represents the errors which can occur. More...
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QGeoSatelliteInfoSource
void satellitesInViewUpdated (const QList< QGeoSatelliteInfo > &satellites)
 If startUpdates() or requestUpdate() is called, this signal is emitted when an update is available on the satellites that are currently in view.
void satellitesInUseUpdated (const QList< QGeoSatelliteInfo > &satellites)
 If startUpdates() or requestUpdate() is called, this signal is emitted when an update is available on the number of satellites that are currently in use.
void errorOccurred (QGeoSatelliteInfoSource::Error)
 This signal is emitted after an error occurred.
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
Static Public Member Functions inherited from QGeoSatelliteInfoSource
static QGeoSatelliteInfoSource * createDefaultSource (QObject *parent)
 Creates and returns a source with the specified parent that reads from the system's default source of satellite update information, or the highest priority available plugin.
static QGeoSatelliteInfoSource * createSource (const QString &sourceName, QObject *parent)
 Creates and returns a source with the given parent, by loading the plugin named sourceName.
static QGeoSatelliteInfoSource * createDefaultSource (const QVariantMap &parameters, QObject *parent)
 Creates and returns a satellite source with the given parent that reads from the system's default sources of satellite data, or the plugin with the highest available priority.
static QGeoSatelliteInfoSource * createSource (const QString &sourceName, const QVariantMap &parameters, QObject *parent)
 Creates and returns a satellite source with the given parent, by loading the plugin named sourceName.
static QStringList availableSources ()
 Returns a list of available source plugins, including the default system backend if one is available.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool disconnect (QMetaObject::Connection &)
static bool disconnect (QMetaObject::Connection &&conn)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Member Functions inherited from QGeoSatelliteInfoSource
 QGeoSatelliteInfoSource (QGeoSatelliteInfoSourcePrivate &dd, QObject *parent)
Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
Properties inherited from QGeoSatelliteInfoSource
int updateInterval
 This property holds the requested interval in milliseconds between each update.
int minimumUpdateInterval
 This property holds the minimum time (in milliseconds) required to retrieve a satellite update.
Properties inherited from QObject
QString objectName
 the name of this object
Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 183 of file qohosgeosatelliteinfosource.cpp.

Constructor & Destructor Documentation

◆ QOhosGeoSatelliteInfoSource() [1/2]

QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::QOhosGeoSatelliteInfoSource ( QObject * parent)

Definition at line 225 of file qohosgeosatelliteinfosource.cpp.

References QOhosGeoSatelliteInfoSource().

Referenced by QOhosGeoSatelliteInfoSource().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~QOhosGeoSatelliteInfoSource() [1/2]

QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::~QOhosGeoSatelliteInfoSource ( )
overridedefault

◆ QOhosGeoSatelliteInfoSource() [2/2]

QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::QOhosGeoSatelliteInfoSource ( QObject * parent)

◆ ~QOhosGeoSatelliteInfoSource() [2/2]

QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::~QOhosGeoSatelliteInfoSource ( )
override

Member Function Documentation

◆ error() [1/2]

QGeoSatelliteInfoSource::Error QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::error ( ) const
overridevirtual

Returns the last error that occurred.

Note
Since Qt6 the last error is always reset when calling startUpdates() or requestUpdate().

Implements QGeoSatelliteInfoSource.

Definition at line 248 of file qohosgeosatelliteinfosource.cpp.

◆ error() [2/2]

Error QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::error ( ) const
overridevirtual

Returns the last error that occurred.

Note
Since Qt6 the last error is always reset when calling startUpdates() or requestUpdate().

Implements QGeoSatelliteInfoSource.

◆ minimumUpdateInterval() [1/2]

int QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::minimumUpdateInterval ( ) const
overridevirtual

Implements QGeoSatelliteInfoSource.

Definition at line 241 of file qohosgeosatelliteinfosource.cpp.

References QT_BEGIN_NAMESPACE::updateAsOftenAsNecessaryInterval.

◆ minimumUpdateInterval() [2/2]

int QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::minimumUpdateInterval ( ) const
overridevirtual

Implements QGeoSatelliteInfoSource.

◆ requestUpdate() [1/2]

void QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::requestUpdate ( int timeout)
overridevirtual

Attempts to get the current satellite information and emit satellitesInViewUpdated() and satellitesInUseUpdated() with this information.

If the current satellite information cannot be found within the given timeout (in milliseconds) or if timeout is less than the value returned by minimumUpdateInterval(), an errorOccurred() signal with \l {QGeoSatelliteInfoSource::UpdateTimeoutError} {UpdateTimeoutError} is emitted.

If the timeout is zero, the timeout defaults to a reasonable timeout period as appropriate for the source.

This does nothing if another update request is in progress. However it can be called even if startUpdates() has already been called and regular updates are in progress.

Note
Since Qt6 this method always resets the last error to \l {QGeoSatelliteInfoSource::}{NoError} before requesting the satellite information.
To understand how to use this method from an Android service, see \l {Qt Positioning on Android}.

Implements QGeoSatelliteInfoSource.

Definition at line 283 of file qohosgeosatelliteinfosource.cpp.

References checkLocationOrApproximatelyLocationPermissionGranted().

Here is the call graph for this function:

◆ requestUpdate() [2/2]

void QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::requestUpdate ( int timeout)
overridevirtual

Attempts to get the current satellite information and emit satellitesInViewUpdated() and satellitesInUseUpdated() with this information.

If the current satellite information cannot be found within the given timeout (in milliseconds) or if timeout is less than the value returned by minimumUpdateInterval(), an errorOccurred() signal with \l {QGeoSatelliteInfoSource::UpdateTimeoutError} {UpdateTimeoutError} is emitted.

If the timeout is zero, the timeout defaults to a reasonable timeout period as appropriate for the source.

This does nothing if another update request is in progress. However it can be called even if startUpdates() has already been called and regular updates are in progress.

Note
Since Qt6 this method always resets the last error to \l {QGeoSatelliteInfoSource::}{NoError} before requesting the satellite information.
To understand how to use this method from an Android service, see \l {Qt Positioning on Android}.

Implements QGeoSatelliteInfoSource.

◆ setUpdateInterval() [1/2]

void QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::setUpdateInterval ( int msec)
overridevirtual

Reimplemented from QGeoSatelliteInfoSource.

Definition at line 233 of file qohosgeosatelliteinfosource.cpp.

◆ setUpdateInterval() [2/2]

void QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::setUpdateInterval ( int msec)
overridevirtual

Reimplemented from QGeoSatelliteInfoSource.

◆ startUpdates() [1/2]

void QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::startUpdates ( )
overridevirtual

Starts emitting updates at regular intervals.

The updates will be provided whenever new satellite information becomes available.

If satellite information cannot be retrieved or some other form of timeout has occurred the satellitesInViewUpdated() and satellitesInUseUpdated() signals may be emitted with empty parameter lists.

Note
Since Qt6 this method always resets the last error to \l {QGeoSatelliteInfoSource::}{NoError} before starting the updates.
To understand how to use this method from an Android service, see \l {Qt Positioning on Android}.
See also
satellitesInViewUpdated(), satellitesInUseUpdated()

Implements QGeoSatelliteInfoSource.

Definition at line 255 of file qohosgeosatelliteinfosource.cpp.

References checkLocationOrApproximatelyLocationPermissionGranted().

Here is the call graph for this function:

◆ startUpdates() [2/2]

void QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::startUpdates ( )
overridevirtual

Starts emitting updates at regular intervals.

The updates will be provided whenever new satellite information becomes available.

If satellite information cannot be retrieved or some other form of timeout has occurred the satellitesInViewUpdated() and satellitesInUseUpdated() signals may be emitted with empty parameter lists.

Note
Since Qt6 this method always resets the last error to \l {QGeoSatelliteInfoSource::}{NoError} before starting the updates.
To understand how to use this method from an Android service, see \l {Qt Positioning on Android}.
See also
satellitesInViewUpdated(), satellitesInUseUpdated()

Implements QGeoSatelliteInfoSource.

◆ stopUpdates() [1/2]

void QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::stopUpdates ( )
overridevirtual

Stops emitting updates at regular intervals.

Implements QGeoSatelliteInfoSource.

Definition at line 274 of file qohosgeosatelliteinfosource.cpp.

◆ stopUpdates() [2/2]

void QT_BEGIN_NAMESPACE::QOhosGeoSatelliteInfoSource::stopUpdates ( )
overridevirtual

Stops emitting updates at regular intervals.

Implements QGeoSatelliteInfoSource.

The documentation for this class was generated from the following file: