PLearn 0.1
SetOption.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SetOption.h
00004 // 
00005 // Copyright (C) 2003 Pascal Vincent
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: SetOption.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00040 #ifndef SetOption_INC
00041 #define SetOption_INC
00042 
00043 #include "Object.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 class SetOption: public Object
00049 {
00050 protected:
00051     // *********************
00052     // * protected options *
00053     // *********************
00054 
00055     // ### declare protected option fields (such as learnt parameters) here
00056     // ...
00057     
00058 public:
00059 
00060     typedef Object inherited;
00061 
00062     // ************************
00063     // * public build options *
00064     // ************************
00065 
00066     string name; // name of option
00067     string value; // value of option (as a string)
00068 
00069     // ****************
00070     // * Constructors *
00071     // ****************
00072 
00073     // Default constructor, make sure the implementation in the .cc
00074     // initializes all fields to reasonable default values.
00075     SetOption();
00076 
00077 
00078     // ******************
00079     // * Object methods *
00080     // ******************
00081 
00082 private: 
00084     // (Please implement in .cc)
00085     void build_();
00086 
00087 protected: 
00089     // (Please implement in .cc)
00090     static void declareOptions(OptionList& ol);
00091 
00092 public:
00093     // simply calls inherited::build() then build_() 
00094     virtual void build();
00095 
00097     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00098 
00100     inline void apply(PP<Object> obj)
00101     { obj->setOption(name, value); }
00102 
00105     void apply(PP<Object> obj, const map<string, string>& aliases);
00106 
00108     PLEARN_DECLARE_OBJECT(SetOption);
00109 
00110 };
00111 
00112 // Declares a few other classes and functions related to this class
00113 DECLARE_OBJECT_PTR(SetOption);
00114   
00115 } // end of namespace PLearn
00116 
00117 #endif
00118 
00119 
00120 /*
00121   Local Variables:
00122   mode:c++
00123   c-basic-offset:4
00124   c-file-style:"stroustrup"
00125   c-file-offsets:((innamespace . 0)(inline-open . 0))
00126   indent-tabs-mode:nil
00127   fill-column:79
00128   End:
00129 */
00130 // 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