SimEventQueueConfigurator.H

Go to the documentation of this file.
00001 /*!@file Simulation/SimEventQueueConfigurator.H Pick a SimEventQueue */
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/SimEventQueueConfigurator.H $
00035 // $Id: SimEventQueueConfigurator.H 8160 2007-03-21 21:34:16Z rjpeters $
00036 //
00037 
00038 #ifndef SIMULATION_SIMEVENTQUEUECONFIGURATOR_H_DEFINED
00039 #define SIMULATION_SIMEVENTQUEUECONFIGURATOR_H_DEFINED
00040 
00041 #include "Component/ModelComponent.H"
00042 #include "Component/ModelParam.H"
00043 class SimEventQueue;
00044 
00045 class SimEventQueueConfigurator : public ModelComponent
00046 {
00047 public:
00048   //! Constructor
00049   SimEventQueueConfigurator(OptionManager& mgr,
00050                             const std::string& descrName =
00051                             "SimEvent Queue Configurator",
00052                             const std::string& tagName =
00053                             "SimEventQueueConfigurator");
00054 
00055   //! destructor
00056   virtual ~SimEventQueueConfigurator();
00057 
00058   //! Get the chosen SimEventQueue
00059   /*! You should call this during start() of the ModelComponent that
00060     needs the queue. CAUTION: this may be a rutz::shared_ptr(NULL) if
00061     no queue has been chosen. */
00062   nub::ref<SimEventQueue> getQ() const;
00063 
00064   //! Intercept people changing our itsSEQname ModelParam
00065   /*! See ModelComponent.H; as parsing the command-line or reading a
00066     config file sets our name, we'll also here instantiate a queue of
00067     the proper type (and export its options) */
00068   virtual void paramChanged(ModelParamBase* const param,
00069                             const bool valueChanged,
00070                             ParamClient::ChangeStatus* status);
00071 
00072 protected:
00073   OModelParam<std::string> itsSEQname; //!< Type of queue
00074 
00075 private:
00076   nub::ref<SimEventQueue> itsQ; // the queue
00077 };
00078 
00079 // ######################################################################
00080 /* So things look consistent in everyone's emacs... */
00081 /* Local Variables: */
00082 /* mode: c++ */
00083 /* indent-tabs-mode: nil */
00084 /* End: */
00085 
00086 #endif // SIMULATION_SIMEVENTQUEUECONFIGURATOR_H_DEFINED
Generated on Sun May 8 08:42:18 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3