ThreadCommunication.h

Go to the documentation of this file.
00001 //# Copyright (C) 2009
00002 //# Associated Universities, Inc. Washington DC, USA.
00003 //#
00004 //# This library is free software; you can redistribute it and/or modify it
00005 //# under the terms of the GNU Library General Public License as published by
00006 //# the Free Software Foundation; either version 2 of the License, or (at your
00007 //# option) any later version.
00008 //#
00009 //# This library is distributed in the hope that it will be useful, but WITHOUT
00010 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00011 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00012 //# License for more details.
00013 //#
00014 //# You should have received a copy of the GNU Library General Public License
00015 //# along with this library; if not, write to the Free Software Foundation,
00016 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00017 //#
00018 //# Correspondence concerning AIPS++ should be addressed as follows:
00019 //#        Internet email: aips2-request@nrao.edu.
00020 //#        Postal address: AIPS++ Project Office
00021 //#                        National Radio Astronomy Observatory
00022 //#                        520 Edgemont Road
00023 //#                        Charlottesville, VA 22903-2475 USA
00024 //#
00025 
00026 #ifndef THREADCOMMUNICATION_H_
00027 #define THREADCOMMUNICATION_H_
00028 
00029 #include <casa/BasicSL/String.h>
00030 
00031 namespace casa {
00032 
00038 class ThreadCommunication {
00039 
00040 public:
00041 
00042         // These signals are used to update the QtProgressWidget across different
00043         // threads.  They shouldn't need to be used by other classes, even
00044         // children.
00045         // <group>
00046         virtual void initializeProgress(const String& operationName) = 0;
00047         virtual void setProgress(unsigned int progress, const String& status) = 0;
00048         virtual void finishProgress() = 0;
00049         // </group>
00050 
00051         // Allows the cache to set the progress.
00052         virtual void setProgress(unsigned int progress) =0;
00053 
00054 
00055         // Allows the cache to set the status.
00056         virtual void setStatus(const String& status) = 0;
00057         virtual void setError( const String& errorMessage ) = 0;
00058         virtual void setAllowedOperations(bool background, bool pauseResume, bool cancel) = 0;
00059 
00060         //Thread signals it is done.
00061         virtual void finished( ) = 0;
00062 
00063         //Enquire whether the thread was cancelled by the user.
00064         virtual bool wasCanceled() const = 0;
00065 
00066 protected:
00067         ThreadCommunication(){}
00068         virtual ~ThreadCommunication(){}
00069 };
00070 
00071 }
00072 #endif /* THREADCOMMUNICATION_H_ */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1