MexModelManager.H

Go to the documentation of this file.
00001 /*!@file Matlab/MexModelManager.H
00002  */
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2002   //
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: Dirk Walther <walther@caltech.edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Matlab/MexModelManager.H $
00035 // $Id: MexModelManager.H 6022 2005-12-08 02:40:53Z rjpeters $
00036 //
00037 
00038 #ifndef MEXMODELMANAGER_H_DEFINED
00039 #define MEXMODELMANAGER_H_DEFINED
00040 
00041 #include "Component/ModelManager.H"
00042 #include <mex.h>
00043 #include <vector>
00044 
00045 //! A special form of ModelManager used in mex files
00046 class MexModelManager : public ModelManager
00047 {
00048 public:
00049   // ######################################################################
00050 
00051   //! Default constructor
00052   /*! @param descrName descriptive name
00053     @param tagName tag name (see ModelComponent.H)*/
00054   MexModelManager(const std::string& descrName = "Mex Model",
00055                   const std::string& tagName = "mexModel");
00056 
00057   //! Virtual destructor ensures proper destruction of derived classes
00058   virtual ~MexModelManager();
00059 
00060   //! Parse all input arguments
00061   /*! All strings that start with '-' are interpreted as command-line
00062     options, all other arguments will be available though
00063     getExtraMexArg(). Use '--help' for a list of available options.
00064     Returns true upon fully successful parse.
00065     @param nrhs the number of command-line args
00066     @param prhs the input args
00067     @param usage a textual description of the expected usage format
00068     @param minarg the minimum number of non-optional arguments
00069     @param maxarg the maximum number of non-optional args, or -1 if
00070       unbounded */
00071   bool parseMexCommandLine(const int nrhs, const mxArray *prhs[],
00072                            const char *usage, const int minarg, const int maxarg);
00073 
00074   //! Get the number of available extra args
00075   uint numExtraMexArgs() const;
00076 
00077   //! Get an extra arg, by number
00078   const mxArray* getExtraMexArg(const uint num) const;
00079 
00080   //! Called to leave the program, e.g. when printing the Help messages
00081   /*!This implementation calls mexErrMsgTxt.*/
00082   void exitMexFunction(int return_code = 0);
00083 
00084 protected:
00085 
00086   //! non-option command-line args
00087   std::vector<const mxArray*> extraMexArgs;
00088 
00089 };
00090 
00091 
00092 #endif
00093 
00094 // ######################################################################
00095 /* So things look consistent in everyone's emacs... */
00096 /* Local Variables: */
00097 /* indent-tabs-mode: nil */
00098 /* End: */
Generated on Sun May 8 08:05:19 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3