Pause.H

Go to the documentation of this file.
00001 /*!@file Util/Pause.H simple global pause toggle */
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/Pause.H $
00035 // $Id: Pause.H 5832 2005-11-01 19:20:52Z rjpeters $
00036 //
00037 
00038 #ifndef UTIL_PAUSE_H_DEFINED
00039 #define UTIL_PAUSE_H_DEFINED
00040 
00041 //! Change in to or out of the paused state
00042 /*! Note that this actually does nothing itself; all it does is change
00043     the result of isPaused(). Individual applications can check
00044     isPaused() in their main loops and act accordingly; or, they
00045     equally well just ignore isPaused() if they don't care to pause. */
00046 void setPause(bool on);
00047 
00048 //! Check if we are in the paused state
00049 bool isPaused();
00050 
00051 //! Simple class to help main loops handle pause/unpause events
00052 class PauseWaiter
00053 {
00054 public:
00055   //! Constructor
00056   /*! @param usecs how many microseconds to usleep() in each wait cycle */
00057   PauseWaiter(const int usecs = 50000);
00058 
00059   //! Check if we are in the paused state
00060   /*! Applications can use the return value to modify the behavior of
00061       their main loops accordingly. */
00062   bool checkPause();
00063 
00064 private:
00065   int itsUsecsWait;
00066   bool itsInPause;
00067 };
00068 
00069 //! Check if we are in the paused state, and if so, loop until we become unpaused
00070 /*!
00071     @return how many wait cycles were spent waiting to become unpaused
00072  */
00073 int waitForPause(const int usecs = 50000);
00074 
00075 // ######################################################################
00076 /* So things look consistent in everyone's emacs... */
00077 /* Local Variables: */
00078 /* mode: c++ */
00079 /* indent-tabs-mode: nil */
00080 /* End: */
00081 
00082 #endif // UTIL_PAUSE_H_DEFINED
Generated on Sun May 8 08:42:28 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3