swift
Signals | Public Member Functions | Protected Member Functions | List of all members
swift::core::vatsim::CVatsimMetarReader Class Reference

Read METARs from VATSIM. More...

Inheritance diagram for swift::core::vatsim::CVatsimMetarReader:
[legend]

Signals

void metarsRead (const swift::misc::weather::CMetarList &metars)
 METARs have been read and converted to swift::misc::weather::CMetarList.
 
void dataRead (swift::misc::network::CEntityFlags::Entity entity, swift::misc::network::CEntityFlags::ReadState state, int number, const QUrl &url)
 Data have been read.
 
- Signals inherited from swift::misc::CWorkerBase
void aboutToStart ()
 Emitted when the task is about to start.
 
void finished ()
 Emitted when the task is finished. More...
 

Public Member Functions

 CVatsimMetarReader (QObject *owner)
 Constructor.
 
void readInBackgroundThread ()
 Read / re-read metars.
 
virtual swift::misc::weather::CMetarList getMetars () const
 Get METARs. More...
 
virtual swift::misc::weather::CMetar getMetarForAirport (const swift::misc::aviation::CAirportIcaoCode &icao) const
 Get METAR for airport. More...
 
- Public Member Functions inherited from swift::core::CThreadedReader
virtual ~CThreadedReader ()
 Destructor.
 
QDateTime getUpdateTimestamp () const
 Thread safe, get update timestamp. More...
 
void setUpdateTimestamp (const QDateTime &updateTimestamp=QDateTime::currentDateTimeUtc())
 Thread safe, set update timestamp. More...
 
bool updatedWithinLastMs (qint64 timeLastMs)
 Was setup read within last xx milliseconds. More...
 
bool isMarkedAsFailed () const
 Is marked as read failed. More...
 
void setMarkedAsFailed (bool failed)
 Set marker for read failed. More...
 
swift::misc::network::CUrlLogList getReadLog () const
 Get the read log. More...
 
void startReader ()
 Starts the reader. More...
 
void pauseReader ()
 Pauses the reader. More...
 
void markAsUsedInUnitTest ()
 Used in unit test. More...
 
bool hasPendingUrls () const
 Has pending URLs? More...
 
swift::misc::network::CUrlLogList getUrlLogList () const
 Get the URL log list. More...
 
int getNetworkReplyProgress () const
 Progress 0..100. More...
 
QPair< qint64, qint64 > getNetworkReplyBytes () const
 Max./current bytes.
 
- Public Member Functions inherited from swift::misc::CContinuousWorker
 CContinuousWorker (QObject *owner, const QString &name)
 Constructor. More...
 
void start (QThread::Priority priority=QThread::InheritPriority)
 Starts a thread and moves the worker into it.
 
void quit () noexcept final
 Stops the thread the next time around its event loop. The thread and the worker will then be deleted. More...
 
void quitAndWait () noexcept final
 Calls quit() and blocks until the thread is finished. More...
 
bool isEnabled () const
 Enabled (running)? More...
 
void setEnabled (bool enabled)
 Enabled (running)? More...
 
void startUpdating (int updateTimeSecs)
 Start updating (start/stop timer) More...
 
const QString & getName ()
 Name of the worker.
 
const QObject * owner () const
 Owner of the worker.
 
- Public Member Functions inherited from swift::misc::CWorkerBase
template<typename T , typename F >
void then (T *context, F functor)
 Connects to a functor or method which will be called when the task is finished. More...
 
template<typename F >
void then (F functor)
 Connects to a functor which will be called when the task is finished. More...
 
bool isFinished () const
 Returns true if the task has finished. More...
 
template<typename F >
void doIfFinished (F functor) const
 Executes some code (in the caller's thread) if the task has finished. More...
 
template<typename F >
void doIfNotFinished (F functor) const
 Executes some code (in the caller's thread) if the task has not finished. More...
 
template<typename F1 , typename F2 >
void doIfFinishedElse (F1 ifFunctor, F2 elseFunctor) const
 Executes some code (in the caller's thread) if the task has finished and some different code if it has not finished. More...
 
void waitForFinished () noexcept
 Blocks until the task is finished. More...
 
void abandon () noexcept
 Notify the task that its result is no longer needed, so it can finish early. More...
 
void abandonAndWait () noexcept
 Convenience to call abandon() followed by waitForFinished().
 

Protected Member Functions

virtual void doWorkImpl ()
 This method does the actual work in the derived class.
 
- Protected Member Functions inherited from swift::core::CThreadedReader
 CThreadedReader (QObject *owner, const QString &name)
 Constructor.
 
qint64 lastModifiedMsSinceEpoch (QNetworkReply *nwReply) const
 When was reply last modified, -1 if N/A.
 
void threadAssertCheck () const
 Make sure everthing runs correctly in own thread.
 
bool didContentChange (const QString &content, int startPosition=-1)
 Stores new content hash and returns if content changed (based on hash value. More...
 
void setInitialAndPeriodicTime (int initialTime, int periodicTime)
 Set initial and periodic times.
 
bool doWorkCheck () const
 Still enabled etc.? More...
 
QNetworkReply * getFromNetworkAndLog (const swift::misc::network::CUrl &url, const swift::misc::CSlot< void(QNetworkReply *)> &callback)
 Get request from network, and log with m_urlReadLog. More...
 
virtual void networkReplyProgress (int logId, qint64 current, qint64 max, const QUrl &url)
 Network request progress.
 
void logNetworkReplyReceived (QNetworkReply *reply)
 Network reply received, mark in m_urlReadLog. More...
 
- Protected Member Functions inherited from swift::misc::CContinuousWorker
virtual void initialize ()
 Called when the thread is started.
 
virtual void cleanup ()
 Called when the thread is finished.
 
virtual void beforeQuit () noexcept
 Called before quit is called. More...
 
virtual unsigned long waitTimeoutMs () const
 Wait time for quitAndWait, 0 means not waiting.
 
void stopUpdateTimer ()
 Safely stop update time.
 
- Protected Member Functions inherited from swift::misc::CWorkerBase
 CWorkerBase ()
 Constructor.
 
 ~CWorkerBase ()
 Destructor.
 
bool isAbandoned () const
 For the task to check whether it can finish early. More...
 
bool hasStarted () const
 True if the worker has started.
 
void setStarted ()
 Mark the task as started.
 
void setFinished ()
 Mark the task as finished.
 

Additional Inherited Members

- Static Public Member Functions inherited from swift::core::CThreadedReader
static const QStringList & getLogCategories ()
 Log categories.
 
- Static Public Member Functions inherited from swift::misc::CWorkerBase
static const QStringList & getLogCategories ()
 Log categories.
 
static const QSet< CWorkerBase * > & allWorkers ()
 All workers currently existing.
 
- Static Protected Member Functions inherited from swift::core::CThreadedReader
static void logInconsistentData (const swift::misc::CStatusMessage &msg, const char *funcInfo=nullptr)
 Use this to log inconsistent data. More...
 
- Protected Attributes inherited from swift::core::CThreadedReader
QReadWriteLock m_lock
 lock which can be used from the derived classes More...
 
std::atomic_int m_networkReplyProgress
 Progress percentage 0...100.
 
std::atomic_llong m_networkReplyCurrent
 current bytes
 
std::atomic_llong m_networkReplyNax
 max bytes
 
- Protected Attributes inherited from swift::misc::CContinuousWorker
QTimer m_updateTimer { this }
 timer which can be used by implementing classes
 

Detailed Description

Read METARs from VATSIM.

Definition at line 24 of file vatsimmetarreader.h.

Member Function Documentation

◆ getMetarForAirport()

CMetar swift::core::vatsim::CVatsimMetarReader::getMetarForAirport ( const swift::misc::aviation::CAirportIcaoCode icao) const
virtual

Get METAR for airport.

Remarks
This function is thread safe.

Definition at line 53 of file vatsimmetarreader.cpp.

◆ getMetars()

CMetarList swift::core::vatsim::CVatsimMetarReader::getMetars ( ) const
virtual

Get METARs.

Remarks
This function is thread safe.

Definition at line 47 of file vatsimmetarreader.cpp.


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