SimulationViewerConfigurator.H

Go to the documentation of this file.
00001 /*!@file Neuro/SimulationViewerConfigurator.H pick a SimulationViewer */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2003   //
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/Neuro/SimulationViewerConfigurator.H $
00035 // $Id: SimulationViewerConfigurator.H 8160 2007-03-21 21:34:16Z rjpeters $
00036 //
00037 
00038 #ifndef SIMULATIONVIEWERCONFIGURATOR_H_DEFINED
00039 #define SIMULATIONVIEWERCONFIGURATOR_H_DEFINED
00040 
00041 #include "Component/ModelComponent.H"
00042 #include "Component/ModelParam.H"
00043 
00044 class SimulationViewer;
00045 
00046 //! SimulationViewer configurator
00047 /*! This will export the --sv-type=XX command-line option and will
00048   instantiate a SimulationViewer of the desired type as the option gets
00049   assigned a value. As this happens, new options may become available
00050   in the command-line. To see them, use --help AFTER you have chosen
00051   the type to use. The current SimulationViewer may be retrieved using
00052   getSV(). */
00053 class SimulationViewerConfigurator : public ModelComponent
00054 {
00055 public:
00056   //! Constructor
00057   SimulationViewerConfigurator(OptionManager& mgr,
00058                            const std::string& descrName =
00059                            "Simulation Viewer Configurator",
00060                            const std::string& tagName =
00061                            "SimulationViewerConfigurator");
00062 
00063   //! destructor
00064   virtual ~SimulationViewerConfigurator();
00065 
00066   //! Get the chosen SimulationViewer
00067   /*! You should call this during start() of the ModelComponent that
00068       needs the SimulationViewer. The result will never be null (since
00069       it's a nub::ref, not a nub::soft_ref), but it may be a "stub"
00070       type (e.g. SimulationViewerStub). */
00071   nub::ref<SimulationViewer> getSV() const;
00072 
00073 protected:
00074   OModelParam<std::string> itsSVtype; //!< type of viewer
00075 
00076   //! Intercept people changing our ModelParam
00077   /*! See ModelComponent.H; as parsing the command-line or reading a
00078     config file sets our name, we'll also here instantiate a
00079     viewer of the proper type (and export its options) */
00080   virtual void paramChanged(ModelParamBase* const param,
00081                             const bool valueChanged,
00082                             ParamClient::ChangeStatus* status);
00083 
00084 private:
00085   nub::ref<SimulationViewer> itsSV; // the viewer
00086 };
00087 
00088 #endif
00089 
00090 // ######################################################################
00091 /* So things look consistent in everyone's emacs... */
00092 /* Local Variables: */
00093 /* indent-tabs-mode: nil */
00094 /* End: */
Generated on Sun May 8 08:41:04 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3