Teuchos_TestForException.cpp

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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #include "Teuchos_TestForException.hpp"
00030 
00031 
00032 namespace { int throwNumber = 0; }
00033 
00034 
00035 void TestForException_incrThrowNumber()
00036 {
00037   ++throwNumber;
00038 }
00039 
00040 
00041 int TestForException_getThrowNumber()
00042 {
00043   return throwNumber;
00044 }
00045 
00046 
00047 void TestForException_break( const std::string &errorMsg )
00048 {
00049   int break_on_me;
00050   break_on_me = errorMsg.length(); // Use errMsg to avoid compiler warning.
00051   // Above is just some statement for the debugger to break on.  Note: now is
00052   // a good time to examine the stack trace and look at the error message in
00053   // 'errorMsg' to see what happened.  In GDB just type 'where' or you can go
00054   // up by typing 'up' and moving up in the stack trace to see where you are
00055   // and how you got to this point in the code where you are throwning this
00056   // exception!  Typing in a 'p errorMsg' will show you what the error message
00057   // is.  Also, you should consider adding a conditional breakpoint in this
00058   // function based on a specific value of 'throwNumber' if the exception you
00059   // want to example is not the first.
00060 }

Generated on Tue Oct 20 12:45:26 2009 for Teuchos - Trilinos Tools Package by doxygen 1.4.7