module.h

00001 /***************************************************************************
00002  *   clipsmm C++ wrapper for the CLIPS c library                           *
00003  *   Copyright (C) 2006 by Rick L. Vinyard, Jr.                            *
00004  *   rvinyard@cs.nmsu.edu                                                  *
00005  *                                                                         *
00006  *   This program is free software; you can redistribute it and/or modify  *
00007  *   it under the terms of version 2 of the GNU General Public License as  *
00008  *   published by the Free Software Foundation.                            *
00009  *                                                                         *
00010  *   This program is distributed in the hope that it will be useful,       *
00011  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00012  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
00013  *   GNU General Public License for more details.                          *
00014  *                                                                         *
00015  *   You should have received a copy of the GNU Lesser General Public      *
00016  *   License along with this library; if not, write to the                 *
00017  *   Free Software Foundation, Inc.,                                       *
00018  *   51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA              *
00019  ***************************************************************************/
00020 #ifndef CLIPSMODULE_H
00021 #define CLIPSMODULE_H
00022 
00023 #include <clipsmm/environmentobject.h>
00024 
00025 namespace CLIPS {
00026 
00030 class Module: public EnvironmentObject {
00031 public:
00032   typedef CLIPSPointer<Module> pointer;
00033 
00034   Module( Environment& environment, void* cobj=NULL );
00035 
00036   static Module::pointer create( Environment& environment, void* cobj=NULL );
00037 
00038   ~Module();
00039 
00040   std::string name();
00041 
00042   std::string formatted();
00043 
00044   Module::pointer next();
00045 
00046   // TODO add accessors for getting items associated with a module
00047 
00049   Module::pointer set_current();
00050 
00051   void focus();
00052 
00053 };
00054 
00055 }
00056 
00057 #endif

Generated on Sun Nov 12 11:55:35 2006 by  doxygen 1.5.1