00001 /*!@file Util/JobWithSemaphore.H Convenience subclass of JobServer::Job that includes a semaphore to communicate job completion */ 00002 00003 // //////////////////////////////////////////////////////////////////// // 00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005 // 00005 // by the University of Southern California (USC) and the iLab at USC. // 00006 // See http://iLab.usc.edu for information about this project. // 00007 // //////////////////////////////////////////////////////////////////// // 00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected // 00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency // 00010 // in Visual Environments, and Applications'' by Christof Koch and // 00011 // Laurent Itti, California Institute of Technology, 2001 (patent // 00012 // pending; application number 09/912,225 filed July 23, 2001; see // 00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status). // 00014 // //////////////////////////////////////////////////////////////////// // 00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit. // 00016 // // 00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can // 00018 // redistribute it and/or modify it under the terms of the GNU General // 00019 // Public License as published by the Free Software Foundation; either // 00020 // version 2 of the License, or (at your option) any later version. // 00021 // // 00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope // 00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the // 00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR // 00025 // PURPOSE. See the GNU General Public License for more details. // 00026 // // 00027 // You should have received a copy of the GNU General Public License // 00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write // 00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, // 00030 // Boston, MA 02111-1307 USA. // 00031 // //////////////////////////////////////////////////////////////////// // 00032 // 00033 // Primary maintainer for this file: Rob Peters <rjpeters at usc dot edu> 00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Util/JobWithSemaphore.H $ 00035 // $Id: JobWithSemaphore.H 13653 2010-07-10 01:22:08Z lior $ 00036 // 00037 00038 #ifndef UTIL_JOBWITHSEMAPHORE_H_DEFINED 00039 #define UTIL_JOBWITHSEMAPHORE_H_DEFINED 00040 00041 #include "Util/JobServer.H" 00042 #include "Util/Semaphore.H" 00043 00044 /// Convenience subclass of JobServer::Job that includes a semaphore to communicate job completion 00045 class JobWithSemaphore : public JobServer::Job 00046 { 00047 public: 00048 JobWithSemaphore(); 00049 00050 virtual ~JobWithSemaphore(); 00051 00052 /// Job clients call this to test if the job has finished running 00053 bool isJobDone(); 00054 00055 /// Job clients call this to block until their job has finished running 00056 void wait(); 00057 00058 /// Determine if job client is finished 00059 bool isFinished(); 00060 00061 protected: 00062 /// Job subclass implementors call this at the end of their run() function 00063 void markFinished(); 00064 00065 private: 00066 JobWithSemaphore(const JobWithSemaphore&); // not implemented 00067 JobWithSemaphore& operator=(const JobWithSemaphore&); // not implemented 00068 Semaphore finishedFlag; 00069 bool jobDone; 00070 }; 00071 00072 // ###################################################################### 00073 /* So things look consistent in everyone's emacs... */ 00074 /* Local Variables: */ 00075 /* mode: c++ */ 00076 /* indent-tabs-mode: nil */ 00077 /* End: */ 00078 00079 #endif // UTIL_JOBWITHSEMAPHORE_H_DEFINED