casa::ThreadCommunication Class Reference

Defines communication mechanisms that the model and data can use to communicate with the UI concerning progress and status. More...

#include <ThreadCommunication.h>

Inheritance diagram for casa::ThreadCommunication:

Public Member Functions
virtual void	initializeProgress (const casacore::String &operationName)=0
	These signals are used to update the QtProgressWidget across different threads. More...
virtual void	setProgress (unsigned int progress, const casacore::String &status)=0
virtual void	finishProgress ()=0
virtual void	setProgress (unsigned int progress)=0
	Allows the cache to set the progress. More...
virtual void	setStatus (const casacore::String &status)=0
	Allows the cache to set the status. More...
virtual void	setError (const casacore::String &errorMessage)=0
virtual void	setAllowedOperations (bool background, bool pauseResume, bool cancel)=0
virtual void	finished ()=0
	Thread signals it is done. More...
virtual bool	wasCanceled () const =0
	Enquire whether the thread was cancelled by the user. More...

Protected Member Functions
	ThreadCommunication ()
virtual	~ThreadCommunication ()

Detailed Description

Defines communication mechanisms that the model and data can use to communicate with the UI concerning progress and status.

Definition at line 38 of file ThreadCommunication.h.

Constructor & Destructor Documentation

casa::ThreadCommunication::ThreadCommunication ( )

inlineprotected

Definition at line 67 of file ThreadCommunication.h.

virtual casa::ThreadCommunication::~ThreadCommunication ( )

inlineprotectedvirtual

Definition at line 68 of file ThreadCommunication.h.

Member Function Documentation

virtual void casa::ThreadCommunication::finished ( )

pure virtual

Thread signals it is done.

Implemented in casa::PlotMSThread, and casa::ThreadController.

virtual void casa::ThreadCommunication::finishProgress ( )

pure virtual

Implemented in casa::PlotMSThread, and casa::ThreadController.

virtual void casa::ThreadCommunication::initializeProgress ( const casacore::String &  operationName )

pure virtual

These signals are used to update the QtProgressWidget across different threads.

They shouldn't need to be used by other classes, even children.

Implemented in casa::PlotMSThread, and casa::ThreadController.

virtual void casa::ThreadCommunication::setAllowedOperations ( bool  background, bool  pauseResume, bool  cancel  )

pure virtual

Implemented in casa::ThreadController.

virtual void casa::ThreadCommunication::setError ( const casacore::String &  errorMessage )

pure virtual

Implemented in casa::ThreadController.

virtual void casa::ThreadCommunication::setProgress ( unsigned int  progress, const casacore::String &  status  )

pure virtual

Implemented in casa::PlotMSThread, and casa::ThreadController.

virtual void casa::ThreadCommunication::setProgress ( unsigned int  progress )

pure virtual

Allows the cache to set the progress.

Implemented in casa::PlotMSCacheThread, and casa::ThreadController.

virtual void casa::ThreadCommunication::setStatus ( const casacore::String &  status )

pure virtual

Allows the cache to set the status.

Implemented in casa::PlotMSCacheThread, and casa::ThreadController.

virtual bool casa::ThreadCommunication::wasCanceled ( ) const

pure virtual

Enquire whether the thread was cancelled by the user.

Implemented in casa::ThreadController.

---

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

• casa/code/plotms/Threads/ThreadCommunication.h