Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_CTimeMonitor.cpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #include "Teuchos_CTimeMonitor.h"
00043 #include "Teuchos_TimeMonitor.hpp"
00044 #include "Teuchos_implicit_cast.hpp"
00045 #include "Teuchos_StandardCatchMacros.hpp"
00046 #include "Teuchos_VerboseObject.hpp"
00047 
00048 
00049 namespace {
00050 
00051 
00052 typedef Teuchos::Array< Teuchos::RCP<Teuchos::Time> >  TimerArray_t;
00053 TimerArray_t timerArray;
00054 
00055 
00056 } // namespace
00057 
00058 
00059 int Teuchos_startTimer( char timerName[], int timerID )
00060 {
00061   using Teuchos::implicit_cast;
00062   bool success = true;
00063   try {
00064     if( timerID < 0 ) {
00065       // The timer does not exist so create it!
00066       timerArray.push_back(Teuchos::TimeMonitor::getNewCounter(timerName));
00067       timerArray.back()->start();
00068       return timerArray.size()-1;
00069     }
00070     // Else, the timer already exists so return it
00071     TEUCHOS_TEST_FOR_EXCEPTION(
00072       timerID >=  implicit_cast<int>(timerArray.size()), std::logic_error,
00073       "Teuchos_startTimer(...): Error, timerID="<<timerID
00074       <<" is >= timerArray.size()="<<timerArray.size()
00075       <<" for timerName=\""<<timerName<<"\"!"
00076       );
00077     Teuchos::RCP<Teuchos::Time> timer = timerArray[timerID];
00078     TEUCHOS_TEST_FOR_EXCEPTION(
00079       timer->isRunning(), std::logic_error,
00080       "Teuchos_startTimer(...): Error, timerID="<<timerID
00081       <<", timerName=\""<<timerName<<"\" is already running!"
00082       );
00083     timer->start();
00084   }
00085   TEUCHOS_STANDARD_CATCH_STATEMENTS(true,
00086     *Teuchos::VerboseObjectBase::getDefaultOStream(), success);
00087   if (!success) {
00088     return -1;
00089   }
00090   return timerID;
00091   (void)success; // To avoid wrong compiler warning on GCC 4.6.1 
00092 }
00093 
00094 
00095 void Teuchos_stopTimer( int timerID )
00096 {
00097   using Teuchos::implicit_cast;
00098   bool success = true;
00099   try {
00100     TEUCHOS_TEST_FOR_EXCEPTION(
00101       timerID < 0 || timerID >= implicit_cast<int>(timerArray.size()),
00102       std::logic_error,
00103       "Teuchos_stopTimer(...): Error, timerID="<<timerID<<" is invalid!"
00104       );
00105     Teuchos::RCP<Teuchos::Time> timer = timerArray[timerID];
00106     timer->stop();
00107     // Increment the number of times the timer has been used (start to stop).
00108     timer->incrementNumCalls();
00109   }
00110   TEUCHOS_STANDARD_CATCH_STATEMENTS(true,
00111     *Teuchos::VerboseObjectBase::getDefaultOStream(), success);
00112   (void)success; // GCC 4.6.1 says this variable is unused?
00113 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines