swift
Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
swift::misc::simulation::CBackgroundValidation Class Reference

Validate model files from the sets and check if the model still exists. More...

Inheritance diagram for swift::misc::simulation::CBackgroundValidation:
[legend]

Signals

void validating (bool running)
 Validating.
 
void validated (const CSimulatorInfo &simulator, const CAircraftModelList &validModels, const CAircraftModelList &invalidModels, bool stopped, const CStatusMessageList &msgs)
 Validated for simulator.
 
- 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

 CBackgroundValidation (QObject *owner)
 Constructor.
 
void setCurrentSimulator (const CSimulatorInfo &simulator, const QString &simDirectory, const QStringList &modelDirList)
 Corresponding simulator. More...
 
bool wasAlreadyChecked (const CSimulatorInfo &simulator) const
 Was already checked for simulator? More...
 
bool isValidating () const
 Validation in progress. More...
 
void resetAlreadyChecked (const CSimulatorInfo &simulator)
 Reset checked for simulator. More...
 
swift::misc::simulation::CSimulatorInfo getCurrentSimulator () const
 Corresponding simulator. More...
 
bool triggerValidation (const CSimulatorInfo &simulator, const QString &simDirectory)
 Trigger a validation, returns false if "work in progress". More...
 
bool requestLastValidationResults ()
 Request last results (again), if there are any. More...
 
- 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().
 

Static Public Member Functions

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.
 

Protected Member Functions

virtual void beforeQuit () noexcept
 Called before quit is called. 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 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

- Protected Attributes inherited from swift::misc::CContinuousWorker
QTimer m_updateTimer { this }
 timer which can be used by implementing classes
 

Detailed Description

Validate model files from the sets and check if the model still exists.

Definition at line 25 of file backgroundvalidation.h.

Member Function Documentation

◆ beforeQuit()

void swift::misc::simulation::CBackgroundValidation::beforeQuit ( )
protectedvirtualnoexcept

Called before quit is called.

Remarks
can be used to "clean things up" or request work functions to stop

Reimplemented from swift::misc::CContinuousWorker.

Definition at line 98 of file backgroundvalidation.cpp.

◆ getCurrentSimulator()

CSimulatorInfo swift::misc::simulation::CBackgroundValidation::getCurrentSimulator ( ) const

Corresponding simulator.

Remarks
This function is thread safe.

Definition at line 52 of file backgroundvalidation.cpp.

◆ isValidating()

bool swift::misc::simulation::CBackgroundValidation::isValidating ( ) const
inline

Validation in progress.

Remarks
This function is thread safe.

Definition at line 47 of file backgroundvalidation.h.

◆ requestLastValidationResults()

bool swift::misc::simulation::CBackgroundValidation::requestLastValidationResults ( )

Request last results (again), if there are any.

Remarks
emits CBackgroundValidation::validated signal
This function is thread safe.

Definition at line 77 of file backgroundvalidation.cpp.

◆ resetAlreadyChecked()

void swift::misc::simulation::CBackgroundValidation::resetAlreadyChecked ( const CSimulatorInfo simulator)

Reset checked for simulator.

Remarks
This function is thread safe.

Definition at line 46 of file backgroundvalidation.cpp.

◆ setCurrentSimulator()

void swift::misc::simulation::CBackgroundValidation::setCurrentSimulator ( const CSimulatorInfo simulator,
const QString &  simDirectory,
const QStringList &  modelDirList 
)

Corresponding simulator.

Remarks
This function is thread safe.

Definition at line 31 of file backgroundvalidation.cpp.

◆ triggerValidation()

bool swift::misc::simulation::CBackgroundValidation::triggerValidation ( const CSimulatorInfo simulator,
const QString &  simDirectory 
)

Trigger a validation, returns false if "work in progress".

Remarks
This function is thread safe.

Definition at line 58 of file backgroundvalidation.cpp.

◆ wasAlreadyChecked()

bool swift::misc::simulation::CBackgroundValidation::wasAlreadyChecked ( const CSimulatorInfo simulator) const

Was already checked for simulator?

Remarks
This function is thread safe.

Definition at line 40 of file backgroundvalidation.cpp.


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