SimCallbackClient.H

Go to the documentation of this file.
00001 /*!@file Simulation/SimCallbackClient.H A client for SimCallback hooks */
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@pollux.usc.edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Simulation/SimCallbackClient.H $
00035 // $Id: SimCallbackClient.H 14376 2011-01-11 02:44:34Z pez $
00036 //
00037 
00038 #ifndef SIMULATION_SIMCALLBACKCLIENT_H_DEFINED
00039 #define SIMULATION_SIMCALLBACKCLIENT_H_DEFINED
00040 
00041 class SimCallbackBase;
00042 class SimEventQueue;
00043 
00044 #include <cstddef>      // needed for size_t
00045 #include <vector>
00046 
00047 //! Client for SimCallback hooks
00048 /*! SimModule derives from this class, which provides the facilities
00049     to hold a bunch of SimCallback hooks to SimEventQueue callbacks. */
00050 class SimCallbackClient {
00051 public:
00052   // Constructor
00053   SimCallbackClient();
00054 
00055   //! Destructor
00056   virtual ~SimCallbackClient();
00057 
00058   //! Register a new callback
00059   void registerSimCallback(SimCallbackBase *s);
00060 
00061   //! Return the number of callbacks
00062   size_t numCallbacks() const;
00063 
00064 private:
00065   friend class SimEventQueue;
00066   std::vector<SimCallbackBase *> itsSimCallbacks;
00067 };
00068 
00069 
00070 // ######################################################################
00071 /* So things look consistent in everyone's emacs... */
00072 /* Local Variables: */
00073 /* mode: c++ */
00074 /* indent-tabs-mode: nil */
00075 /* End: */
00076 
00077 #endif // SIMULATION_SIMCALLBACKCLIENT_H_DEFINED
Generated on Sun May 8 08:42:17 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3