PLearn 0.1
RunObject.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RunObject.h
00004 //
00005 // Copyright (C) 2004-2005 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 4403 2005-11-02 12:56:31Z tihocan $ 
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     PPath save_object_name;
00076 
00077     TVec< PP<Object> >  objects;
00078     TVec<PPath>         save_files;
00079     bool                run_objects;
00080 
00081     // ****************
00082     // * Constructors *
00083     // ****************
00084 
00086     RunObject();
00087 
00088     // ******************
00089     // * Object methods *
00090     // ******************
00091 
00092 private: 
00093 
00095     void build_();
00096 
00097 protected: 
00098 
00100     static void declareOptions(OptionList& ol);
00101 
00102 public:
00103 
00104     // Declares other standard object methods
00105     //  If your class is not instantiatable (it has pure virtual methods)
00106     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 
00107     PLEARN_DECLARE_OBJECT(RunObject);
00108 
00109     // simply calls inherited::build() then build_() 
00110     virtual void build();
00111 
00113     // (PLEASE IMPLEMENT IN .cc)
00114     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00115 
00117     virtual void run();
00118 
00119 };
00120 
00121 // Declares a few other classes and functions related to this class
00122 DECLARE_OBJECT_PTR(RunObject);
00123   
00124 } // end of namespace PLearn
00125 
00126 #endif
00127 
00128 
00129 /*
00130   Local Variables:
00131   mode:c++
00132   c-basic-offset:4
00133   c-file-style:"stroustrup"
00134   c-file-offsets:((innamespace . 0)(inline-open . 0))
00135   indent-tabs-mode:nil
00136   fill-column:79
00137   End:
00138 */
00139 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines