PLearn 0.1
Redirect.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // Redirect.cc
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: Redirect.cc 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Frédéric Bastien
00040 
00044 #include "Redirect.h"
00045 #include <plearn/io/openFile.h>
00046 namespace PLearn {
00047 using namespace std;
00048 
00049 Redirect::Redirect():
00050     active(true)
00051     /* ### Initialize all fields to their default value */
00052 {
00053     // ...
00054 
00055     // ### You may or may not want to call build_() to finish building the object
00056     // build_();
00057 }
00058 
00059 PLEARN_IMPLEMENT_OBJECT(Redirect,
00060                         "Allow to redirect the perr and  pout to a file in a plearn script.",
00061                         "This runnable object will redirect perr or pout when executed.");
00062 
00063 void Redirect::declareOptions(OptionList& ol)
00064 {
00065     // ### Declare all of this object's options here
00066     // ### For the "flags" of each option, you should typically specify  
00067     // ### one of OptionBase::buildoption, OptionBase::learntoption or 
00068     // ### OptionBase::tuningoption. Another possible flag to be combined with
00069     // ### is OptionBase::nosave
00070 
00071     declareOption(ol, "active", &Redirect::active, OptionBase::buildoption,
00072                   "Will do the redirect only if true. Else do nothing.");
00073 
00074     declareOption(ol, "what", &Redirect::what, OptionBase::buildoption,
00075                   "The string perr or pout. Indicated what will be redirected.");
00076 
00077     declareOption(ol, "filename", &Redirect::filename, OptionBase::buildoption,
00078                   "The file where the PStream will be redirected.");
00079 
00080     // Now call the parent class' declareOptions
00081     inherited::declareOptions(ol);
00082 }
00083 
00084 void Redirect::build_()
00085 {
00086     // ### This method should do the real building of the object,
00087     // ### according to set 'options', in *any* situation. 
00088     // ### Typical situations include:
00089     // ###  - Initial building of an object from a few user-specified options
00090     // ###  - Building of a "reloaded" object: i.e. from the complete set of all serialised options.
00091     // ###  - Updating or "re-building" of an object after a few "tuning" options have been modified.
00092     // ### You should assume that the parent class' build_() has already been called.
00093 }
00094 
00095 // ### Nothing to add here, simply calls build_
00096 void Redirect::build()
00097 {
00098     inherited::build();
00099     build_();
00100 }
00101 
00102 void Redirect::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00103 {
00104     inherited::makeDeepCopyFromShallowCopy(copies);
00105     deepCopyField(what, copies);
00106     deepCopyField(filename, copies);
00107 }
00108 
00110 // run //
00112 void Redirect::run() {
00113     //do the redirection
00114     if(!active)
00115         return;
00116     if(what=="perr"){
00117         //the old is closed automatically
00118         perr=openFile(filename,PStream::raw_ascii,"w",false,true);
00119     }else if(what=="pout"){
00120         //the old is closed automatically
00121         pout=openFile(filename,PStream::raw_ascii,"w",false,true);
00122     }else
00123         PLERROR("In Redirect::run() - unknow stream %s to redirect",what.c_str());
00124 }
00125 
00126 } // end of namespace PLearn
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