00001 /*!@file Simulation/SimEventQueueDebug.H Dispatch simulation events */ 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: Laurent Itti <itti@usc.edu> 00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Simulation/SimEventQueueDebug.H $ 00035 // $Id: SimEventQueueDebug.H 11082 2009-04-02 23:31:50Z itti $ 00036 // 00037 00038 #ifndef SIMULATION_SIMEVENTQUEUEDEBUG_H_DEFINED 00039 #define SIMULATION_SIMEVENTQUEUEDEBUG_H_DEFINED 00040 00041 #include "Simulation/SimEventQueue.H" 00042 00043 //! Debug version of SimEventQueue 00044 /*! This version just posts a number of messages about the queue when 00045 events are posted, retrieved, when the queue evolves, etc. */ 00046 class SimEventQueueDebug : public SimEventQueue { 00047 public: 00048 //! Constructor 00049 SimEventQueueDebug(OptionManager& mgr, 00050 const std::string& descrName = "Simulation Event Queue Debug", 00051 const std::string& tagName = "SimEventQueue", 00052 const SimTime starttime = SimTime::ZERO()); 00053 00054 //! Destructor 00055 virtual ~SimEventQueueDebug(); 00056 00057 //! Increment the master clock and delete old events 00058 /*! In addition to the normal behavior, we dump the queue. */ 00059 virtual SimStatus evolve(); 00060 00061 //! Erase the entire queue 00062 /*! In addition to the normal behavior, we report. */ 00063 virtual void clear(); 00064 00065 //! Erase all events with time <= tt 00066 /*! In addition to the normal behavior, we report. */ 00067 virtual void prune(const SimTime& tt); 00068 00069 //! Reset the time to the given value and erase the entire queue 00070 /*! In addition to the normal behavior, we report. */ 00071 virtual void resetTime(const SimTime& tim); 00072 00073 protected: 00074 //! This is called by post() 00075 virtual void postHelper(const std::type_info& etype, 00076 const rutz::shared_ptr<SimEvent>& e); 00077 00078 //! this is called by check() 00079 virtual void checkHelper(const std::type_info& etype, 00080 const rutz::shared_ptr<SimEvent>& e, 00081 const SimModule* caller, 00082 const SimEventQueueFlag flags, 00083 const SimModule* eventsrc); 00084 }; 00085 00086 // ###################################################################### 00087 /* So things look consistent in everyone's emacs... */ 00088 /* Local Variables: */ 00089 /* mode: c++ */ 00090 /* indent-tabs-mode: nil */ 00091 /* End: */ 00092 00093 #endif // SIMULATION_SIMEVENTQUEUE_H_DEFINED