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 | Friends | List of all members
casa::PlotMSCacheThread Class Reference

Subclass of PlotMSThread for loading axes in a PlotMSCache. More...

#include <PlotMSCacheThread.qo.h>

Inheritance diagram for casa::PlotMSCacheThread:
casa::PlotMSThread casa::ThreadController casa::ThreadCommunication

Public Member Functions

 PlotMSCacheThread (QtProgressWidget *progress, PlotMSPlotter *plotter, PMSPTMethod postThreadMethod=NULL, PMSPTObject postThreadObject=NULL)
 
 ~PlotMSCacheThread ()
 Destructor. More...
 
virtual void startOperation ()
 Implements PlotMSThread::startOperation(). More...
 
virtual void cancelOperation ()
 
virtual QString getName () const
 
virtual bool isCacheThread () 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 ()
 
- 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 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 cancel ()
 For when the user requests "cancel" 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 ()
 

Protected Member Functions

void setProgress (unsigned int progress)
 Allows the cache to set the progress. More...
 
void setStatus (const casacore::String &status)
 Allows the cache to set the status. More...
 
void setProgressAndStatus (unsigned int progress, const casacore::String &status)
 Allows the cache to set the progress and the status. More...
 
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

 PlotMSCacheThread (const PlotMSCacheThread &other)
 
PlotMSCacheThread operator= (const PlotMSCacheThread &other)
 

Private Attributes

PlotMSPlotteritsPlotter_
 Plotter. More...
 
PlotMSCacheBaseitsCache_
 Data. More...
 
bool itsLoad_
 Load (true) or release (false) axes. More...
 
std::vector< PMS::Axis > itsAxes_
 Axes. More...
 
std::vector< PMS::DataColumn > itsAxesData_
 Axes data columns. More...
 
casacore::String itsMSName_
 casacore::MS selection/averaging info More...
 
PlotMSSelection itsSelection_
 
PlotMSAveraging itsAveraging_
 
PlotMSTransformations itsTransformations_
 
bool itsSetupPlot_
 Whether to set up the cache afterwards. More...
 
unsigned int itsLastProgress_
 Last set progress. More...
 
casacore::String itsLastStatus_
 Last set status. More...
 

Friends

class PlotMSCacheBase
 
class MSCache
 
class CalCache
 
class PlotMSCacheThreadHelper
 

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 loading axes in a PlotMSCache.

Definition at line 47 of file PlotMSCacheThread.qo.h.

Constructor & Destructor Documentation

casa::PlotMSCacheThread::PlotMSCacheThread ( QtProgressWidget progress,
PlotMSPlotter plotter,
PMSPTMethod  postThreadMethod = NULL,
PMSPTObject  postThreadObject = NULL 
)
casa::PlotMSCacheThread::~PlotMSCacheThread ( )

Destructor.

casa::PlotMSCacheThread::PlotMSCacheThread ( const PlotMSCacheThread other)
private

Member Function Documentation

virtual void casa::PlotMSCacheThread::cancelOperation ( )
virtual
virtual QString casa::PlotMSCacheThread::getName ( ) const
virtual

Implements casa::PlotMSThread.

virtual bool casa::PlotMSCacheThread::isCacheThread ( ) const
virtual

Reimplemented from casa::PlotMSThread.

PlotMSCacheThread casa::PlotMSCacheThread::operator= ( const PlotMSCacheThread other)
private
void casa::PlotMSCacheThread::setProgress ( unsigned int  progress)
inlineprotectedvirtual

Allows the cache to set the progress.

Reimplemented from casa::ThreadController.

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

References itsLastStatus_, and setProgressAndStatus().

void casa::PlotMSCacheThread::setProgressAndStatus ( unsigned int  progress,
const casacore::String status 
)
protected

Allows the cache to set the progress and the status.

Referenced by setProgress(), and setStatus().

void casa::PlotMSCacheThread::setStatus ( const casacore::String status)
inlineprotectedvirtual

Allows the cache to set the status.

Reimplemented from casa::ThreadController.

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

References itsLastProgress_, and setProgressAndStatus().

virtual void casa::PlotMSCacheThread::startOperation ( )
virtual
virtual void casa::PlotMSCacheThread::threadFinished ( )
protectedvirtual

Slot for when the QThread finishes.

Reimplemented from casa::PlotMSThread.

Friends And Related Function Documentation

friend class CalCache
friend

Definition at line 53 of file PlotMSCacheThread.qo.h.

friend class MSCache
friend

Definition at line 52 of file PlotMSCacheThread.qo.h.

friend class PlotMSCacheBase
friend

Definition at line 51 of file PlotMSCacheThread.qo.h.

friend class PlotMSCacheThreadHelper
friend

Definition at line 54 of file PlotMSCacheThread.qo.h.

Member Data Documentation

PlotMSAveraging casa::PlotMSCacheThread::itsAveraging_
private

Definition at line 113 of file PlotMSCacheThread.qo.h.

std::vector<PMS::Axis> casa::PlotMSCacheThread::itsAxes_
private

Axes.

Definition at line 105 of file PlotMSCacheThread.qo.h.

std::vector<PMS::DataColumn> casa::PlotMSCacheThread::itsAxesData_
private

Axes data columns.

Definition at line 108 of file PlotMSCacheThread.qo.h.

PlotMSCacheBase* casa::PlotMSCacheThread::itsCache_
private

Data.

Definition at line 99 of file PlotMSCacheThread.qo.h.

unsigned int casa::PlotMSCacheThread::itsLastProgress_
private

Last set progress.

Definition at line 120 of file PlotMSCacheThread.qo.h.

Referenced by setStatus().

casacore::String casa::PlotMSCacheThread::itsLastStatus_
private

Last set status.

Definition at line 123 of file PlotMSCacheThread.qo.h.

Referenced by setProgress().

bool casa::PlotMSCacheThread::itsLoad_
private

Load (true) or release (false) axes.

Definition at line 102 of file PlotMSCacheThread.qo.h.

casacore::String casa::PlotMSCacheThread::itsMSName_
private

casacore::MS selection/averaging info

Definition at line 111 of file PlotMSCacheThread.qo.h.

PlotMSPlotter* casa::PlotMSCacheThread::itsPlotter_
private

Plotter.

Definition at line 96 of file PlotMSCacheThread.qo.h.

PlotMSSelection casa::PlotMSCacheThread::itsSelection_
private

Definition at line 112 of file PlotMSCacheThread.qo.h.

bool casa::PlotMSCacheThread::itsSetupPlot_
private

Whether to set up the cache afterwards.

Definition at line 117 of file PlotMSCacheThread.qo.h.

PlotMSTransformations casa::PlotMSCacheThread::itsTransformations_
private

Definition at line 114 of file PlotMSCacheThread.qo.h.


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