PLearn 0.1
PTimer.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PTimer.h
00004 //
00005 // Copyright (C) 2006 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 // Authors: Olivier Delalleau
00036 
00040 #ifndef PTimer_INC
00041 #define PTimer_INC
00042 
00043 #include <plearn/base/Object.h>
00044 
00045 namespace PLearn {
00046 
00057 class PTimer : public Object
00058 {
00059     typedef Object inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00066     bool use_time_fct;
00067 public:
00068     //#####  Public Member Functions  #########################################
00069 
00071     PTimer();
00072     PTimer(bool use_time_fct_, bool call_build_ = true);
00073 
00074     // Your other public member functions go here
00075 
00077     real getTimer(const string& timer_name);
00078 
00080     void newTimer(const string& timer_name, bool can_exit = false);
00081 
00083     void resetAllTimers();
00084     
00086     void resetTimer(const string& timer_name);
00087 
00089     void startTimer(const string& timer_name);
00090 
00092     void stopTimer(const string& timer_name);
00093 
00094     //#####  PLearn::Object Protocol  #########################################
00095 
00096     // Declares other standard object methods.
00097     // ### If your class is not instantiatable (it has pure virtual methods)
00098     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 
00099     PLEARN_DECLARE_OBJECT(PTimer);
00100 
00101     // Simply calls inherited::build() then build_() 
00102     virtual void build();
00103 
00105     // (PLEASE IMPLEMENT IN .cc)
00106     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00107 
00108 protected:
00109     
00111     TVec<clock_t> start_clock_t;
00112 
00114     TVec<long> start_long;
00115     
00116     //#####  Protected Options  ###############################################
00117 
00118     Vec total_times;
00119     map<string, int> name_to_idx;
00120     
00121 protected:
00122     //#####  Protected Member Functions  ######################################
00123     
00125     // (PLEASE IMPLEMENT IN .cc)
00126     static void declareOptions(OptionList& ol);
00127 
00128 private: 
00129     //#####  Private Member Functions  ########################################
00130 
00132     // (PLEASE IMPLEMENT IN .cc)
00133     void build_();
00134 
00135 private:
00136     //#####  Private Data Members  ############################################
00137 
00138     // The rest of the private stuff goes here
00139 };
00140 
00141 // Declares a few other classes and functions related to this class
00142 DECLARE_OBJECT_PTR(PTimer);
00143   
00144 } // end of namespace PLearn
00145 
00146 #endif
00147 
00148 
00149 /*
00150   Local Variables:
00151   mode:c++
00152   c-basic-offset:4
00153   c-file-style:"stroustrup"
00154   c-file-offsets:((innamespace . 0)(inline-open . 0))
00155   indent-tabs-mode:nil
00156   fill-column:79
00157   End:
00158 */
00159 // 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