Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

RunObject.h

Go to the documentation of this file.
00001 // -*- C++ -*- 00002 00003 // RunObject.h 00004 // 00005 // Copyright (C) 2004 Olivier Delalleau 00006 // 00007 // Redistribution and use in source and binary forms, with or without 00008 // modification, are permitted provided that the following conditions are met: 00009 // 00010 // 1. Redistributions of source code must retain the above copyright 00011 // notice, this list of conditions and the following disclaimer. 00012 // 00013 // 2. Redistributions in binary form must reproduce the above copyright 00014 // notice, this list of conditions and the following disclaimer in the 00015 // documentation and/or other materials provided with the distribution. 00016 // 00017 // 3. The name of the authors may not be used to endorse or promote 00018 // products derived from this software without specific prior written 00019 // permission. 00020 // 00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00031 // 00032 // This file is part of the PLearn library. For more information on the PLearn 00033 // library, go to the PLearn Web site at www.plearn.org 00034 00035 /* ******************************************************* 00036 * $Id: RunObject.h,v 1.2 2004/07/21 16:30:53 chrish42 Exp $ 00037 ******************************************************* */ 00038 00039 // Authors: Olivier Delalleau 00040 00044 #ifndef RunObject_INC 00045 #define RunObject_INC 00046 00047 #include <plearn/base/Object.h> 00048 00049 namespace PLearn { 00050 using namespace std; 00051 00052 class RunObject: public Object 00053 { 00054 00055 private: 00056 00057 typedef Object inherited; 00058 00059 protected: 00060 00061 // ********************* 00062 // * protected options * 00063 // ********************* 00064 00065 // ### declare protected option fields (such as learnt parameters) here 00066 // ... 00067 00068 public: 00069 00070 // ************************ 00071 // * public build options * 00072 // ************************ 00073 00074 PP<Object> underlying_object; 00075 00076 // **************** 00077 // * Constructors * 00078 // **************** 00079 00081 RunObject(); 00082 00083 // ****************** 00084 // * Object methods * 00085 // ****************** 00086 00087 private: 00088 00090 void build_(); 00091 00092 protected: 00093 00095 static void declareOptions(OptionList& ol); 00096 00097 public: 00098 00099 // Declares other standard object methods 00100 // If your class is not instantiatable (it has pure virtual methods) 00101 // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 00102 PLEARN_DECLARE_OBJECT(RunObject); 00103 00104 // simply calls inherited::build() then build_() 00105 virtual void build(); 00106 00108 // (PLEASE IMPLEMENT IN .cc) 00109 virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies); 00110 00112 virtual void run(); 00113 00114 }; 00115 00116 // Declares a few other classes and functions related to this class 00117 DECLARE_OBJECT_PTR(RunObject); 00118 00119 } // end of namespace PLearn 00120 00121 #endif

Generated on Tue Aug 17 16:04:32 2004 for PLearn by doxygen 1.3.7