casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
casa::PlotMSExportThread Class Reference

Subclass of PlotMSThread for exporting a plot. More...

#include <PlotMSExportThread.qo.h>

Inheritance diagram for casa::PlotMSExportThread:
casa::PlotMSThread casa::PlotOperationWatcher casa::ThreadController casa::ThreadCommunication

Public Member Functions

 PlotMSExportThread (QtProgressWidget *widget, PlotMSPlotter *plotter, const casacore::String &location, PMSPTMethod postThreadMethod=NULL, PMSPTObject postThreadObject=NULL)
 Constructor which takes the plot to export, the export format parameters, and optional post-thread method parameters. More...
 
 ~PlotMSExportThread ()
 Destructor. More...
 
virtual void cancel ()
 For when the user requests "cancel" for the thread. More...
 
virtual void startOperation ()
 Implements PlotMSThread::startOperation(). More...
 
void operationChanged (const PlotOperation &operation)
 Implements PlotOperationWatcher::operationChanged(). More...
 
virtual QString getName () const
 
- Public Member Functions inherited from casa::PlotMSThread
 PlotMSThread (QtProgressWidget *progress, PMSPTMethod postThreadMethod=NULL, PMSPTObject postThreadObject=NULL)
 Constructor which takes the progress widget to use, and an optional post-thread method that should be called when the thread is finished. More...
 
virtual ~PlotMSThread ()
 Destructor. More...
 
virtual void finished ()
 IMPLEMENTED METHODS //. More...
 
virtual void initializeProgress (const casacore::String &operationName)
 Overridden from BackgroundThread in order to update the progress widget on the GUI thread. More...
 
virtual void setProgress (unsigned int progress, const casacore::String &status)
 
virtual void finishProgress ()
 
int getId ()
 
virtual bool isCacheThread () const
 
- Public Member Functions inherited from casa::ThreadController
 ThreadController (ProgressMonitor *progress, PMSPTMethod postThreadMethod=NULL, PMSPTObject postThreadObject=NULL)
 Constructor which takes the progress widget to use, and an optional post-thread method that should be called when the thread is finished. More...
 
virtual ~ThreadController ()
 
virtual void setError (const casacore::String &errorMessage)
 
virtual void setStatus (const casacore::String &status)
 Allows the cache to set the status. More...
 
virtual void setProgress (unsigned int progress)
 Allows the cache to set the progress. More...
 
virtual void setAllowedOperations (bool background, bool pauseResume, bool cancel)
 
 Work classes can specify whether they support background operation, pause/resume,

and cancelling. More...

 
virtual bool wasCanceled () const
 Callback for classes doing the work to check whether they should cancel what they are doing or not. More...
 
void setWorkThread (BackgroundThread *workThread)
 
virtual void background ()
 For when the user requests "background" for the thread. More...
 
virtual void pause ()
 For when the user requests "pause" for the thread. More...
 
virtual void resume ()
 For when the user requests "resume" for the thread. More...
 
virtual void postThreadMethod ()
 Executes the post-thread method as needed. More...
 
bool getResult () const
 Returns the result of the background operation. More...
 
casacore::String getError () const
 Returns any error from the background operation. More...
 
bool isErrorWarning () const
 
casacore::String getErrorTitle () const
 
PlotMSPlotgetPlot ()
 
- Public Member Functions inherited from casa::PlotOperationWatcher
 PlotOperationWatcher ()
 Constructor. More...
 
virtual ~PlotOperationWatcher ()
 Destructor. More...
 

Protected Member Functions

virtual void threadFinished ()
 Slot for when the QThread finishes. More...
 
- Protected Member Functions inherited from casa::PlotMSThread
void signalFinishedOperation (PlotMSThread *thread)
 Signal that clean-up and thread work is done. More...
 
- Protected Member Functions inherited from casa::ThreadController
void startThread ()
 Starts the thread. More...
 
- Protected Member Functions inherited from casa::ThreadCommunication
 ThreadCommunication ()
 
virtual ~ThreadCommunication ()
 

Private Member Functions

 PlotMSExportThread (const PlotMSExportThread &other)
 
PlotMSExportThread operator= (const PlotMSExportThread &other)
 

Private Attributes

std::vector< PlotMSPlot * > itsPlots_
 Plot. More...
 
casacore::String exportLocation
 Format. More...
 
std::vector< std::vector
< PlotOperationPtr > > 
itsOperations_
 Export operations. More...
 
QMutex itsMutex_
 Mutex. More...
 
PlotMSPlotteritsPlotter_
 

Additional Inherited Members

- Signals inherited from casa::PlotMSThread
void finishedOperation (PlotMSThread *thread)
 This signal MUST be emitted after start() has been called, and when the operation has finished. More...
 
void updateProgress (unsigned int value, const QString &statusStr)
 
void initProgress (const QString &operationName)
 
void finalizeProgress ()
 
- Protected Slots inherited from casa::PlotMSThread
void cancelThread ()
 For when the user requests "cancel" for the thread. More...
 
- Protected Attributes inherited from casa::ThreadController
volatile bool wasCanceled_
 Flag for whether thread was canceled or not. More...
 
casacore::String error
 Holds error messages. More...
 
casacore::String errorTitle
 
bool errorWarning
 
ProgressMonitoritsProgressWidget_
 Progress widget. More...
 
PMSPTMethoditsPostThreadMethod_
 Method/Object to run when thread is finished. More...
 
PMSPTObject itsPostThreadObject_
 

Detailed Description

Subclass of PlotMSThread for exporting a plot.

Definition at line 44 of file PlotMSExportThread.qo.h.

Constructor & Destructor Documentation

casa::PlotMSExportThread::PlotMSExportThread ( QtProgressWidget widget,
PlotMSPlotter plotter,
const casacore::String location,
PMSPTMethod  postThreadMethod = NULL,
PMSPTObject  postThreadObject = NULL 
)

Constructor which takes the plot to export, the export format parameters, and optional post-thread method parameters.

casa::PlotMSExportThread::~PlotMSExportThread ( )

Destructor.

casa::PlotMSExportThread::PlotMSExportThread ( const PlotMSExportThread other)
private

Member Function Documentation

virtual void casa::PlotMSExportThread::cancel ( )
virtual

For when the user requests "cancel" for the thread.

Reimplemented from casa::ThreadController.

virtual QString casa::PlotMSExportThread::getName ( ) const
virtual

Implements casa::PlotMSThread.

void casa::PlotMSExportThread::operationChanged ( const PlotOperation operation)
virtual
PlotMSExportThread casa::PlotMSExportThread::operator= ( const PlotMSExportThread other)
private
virtual void casa::PlotMSExportThread::startOperation ( )
virtual
virtual void casa::PlotMSExportThread::threadFinished ( )
protectedvirtual

Slot for when the QThread finishes.

Reimplemented from casa::PlotMSThread.

Member Data Documentation

casacore::String casa::PlotMSExportThread::exportLocation
private

Format.

PlotExportFormat itsFormat_;

Definition at line 82 of file PlotMSExportThread.qo.h.

QMutex casa::PlotMSExportThread::itsMutex_
private

Mutex.

Definition at line 88 of file PlotMSExportThread.qo.h.

std::vector<std::vector<PlotOperationPtr> > casa::PlotMSExportThread::itsOperations_
private

Export operations.

Definition at line 85 of file PlotMSExportThread.qo.h.

std::vector<PlotMSPlot*> casa::PlotMSExportThread::itsPlots_
private

Plot.

Definition at line 78 of file PlotMSExportThread.qo.h.

PlotMSPlotter* casa::PlotMSExportThread::itsPlotter_
private

Definition at line 90 of file PlotMSExportThread.qo.h.


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