ParamClient.H

Go to the documentation of this file.
00001 /*!@file Component/ParamClient.H */
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:
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Component/ParamClient.H $
00035 // $Id: ParamClient.H 8160 2007-03-21 21:34:16Z rjpeters $
00036 //
00037 
00038 #ifndef COMPONENT_PARAMCLIENT_H_DEFINED
00039 #define COMPONENT_PARAMCLIENT_H_DEFINED
00040 
00041 #include "Component/ParamFlags.H"
00042 
00043 class ModelParamBase;
00044 class OptionedModelParam;
00045 
00046 //! An abstract interface class for clients of model params
00047 /*! Using this abstract interface class allows us to decouple the
00048     concrete model param classes (NModelParam and OModelParam) from
00049     the concrete client class (just ModelComponent, for now). */
00050 class ParamClient
00051 {
00052 public:
00053   //! Default constructor
00054   ParamClient();
00055 
00056   //! Virtual destructor for proper base class destruction.
00057   virtual ~ParamClient();
00058 
00059   //! Our parameters will register with us upon construction
00060   virtual void registerParam(ModelParamBase* mp) = 0;
00061 
00062   //! Our parameters will register with us upon construction
00063   /*! @param flags Pass USE_MY_VAL here if you want the current value
00064       of the model param to be taken as the new default value,
00065       otherwise pass 0 for flags. */
00066   virtual void registerOptionedParam(OptionedModelParam* mp,
00067                                      const ParamFlag flags) = 0;
00068 
00069   //! Our parameters will un-register with us upon destruction
00070   virtual void unregisterParam(const ModelParamBase* mp) = 0;
00071 
00072   //! Return type for paramChange() indicating whether a param change was allowed
00073   enum ChangeStatus
00074     {
00075       CHANGE_ACCEPTED,
00076       CHANGE_REJECTED
00077     };
00078 
00079   //! Our params call us back with this function whenever they change value
00080   /*! Base classes should override this function if they need to take
00081       special action when param changes value.
00082 
00083       @param param the address of the ModelParamBase that changed;
00084              subclasses can compare this with the addresses of their
00085              model param members to figure out which is the relevant
00086              param
00087 
00088       @param valueChanged true if the value actually changed, false if
00089              the value was "set" but the new value is the same as the
00090              old value; some clients may want to avoid re-doing
00091              expensive operations if the value did not actually change
00092 
00093       @param status the subclass that implements paramChanged() should
00094              set *status to CHANGE_REJECTED if it wishes to reject a
00095              particular parameter change; the caller of paramChanged()
00096              is expected to set *status to CHANGE_ACCEPTED prior to
00097              calling paramChanged(), so the implentation of
00098              paramChanged() does not need to set *status
00099              CHANGE_ACCEPTED if it wishes to allow the change since
00100              that will already be the default status
00101   */
00102   virtual void paramChanged(ModelParamBase* param,
00103                             const bool valueChanged,
00104                             ChangeStatus* status) = 0;
00105 };
00106 
00107 // ######################################################################
00108 /* So things look consistent in everyone's emacs... */
00109 /* Local Variables: */
00110 /* indent-tabs-mode: nil */
00111 /* End: */
00112 
00113 #endif // COMPONENT_PARAMCLIENT_H_DEFINED
Generated on Sun May 8 08:40:23 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3