Teuchos - Trilinos Tools Package Version of the Day
Teuchos_VerbosityLevel.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 // 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_VerbosityLevel.hpp"
00043 #include "Teuchos_Array.hpp"
00044 #include "Teuchos_as.hpp"
00045 
00046 
00047 namespace {
00048 
00049 
00050 const Teuchos::Array<Teuchos::EVerbosityLevel> verbLevelArray =
00051   Teuchos::tuple<Teuchos::EVerbosityLevel>(
00052     Teuchos::VERB_NONE,
00053     Teuchos::VERB_LOW,
00054     Teuchos::VERB_MEDIUM,
00055     Teuchos::VERB_HIGH,
00056     Teuchos::VERB_EXTREME
00057     );
00058 
00059 
00060 } // namespace
00061 
00062 
00063 
00064 std::string Teuchos::toString(const EVerbosityLevel verbLevel)
00065 {
00066   switch(verbLevel) {
00067     case VERB_DEFAULT:
00068       return "VERB_DEFAULT";
00069     case VERB_NONE:
00070       return "VERB_NONE";
00071     case VERB_LOW:
00072       return "VERB_LOW";
00073     case VERB_MEDIUM:
00074       return "VERB_MEDIUM";
00075     case VERB_HIGH:
00076       return "VERB_HIGH";
00077     case VERB_EXTREME:
00078       return "VERB_EXTREME";
00079     default:
00080       TEUCHOS_TEST_FOR_EXCEPT("Should never get here!");
00081   }
00082   return ""; // Never get here!
00083 }
00084 
00085 
00086 bool Teuchos::includesVerbLevel(
00087   const EVerbosityLevel verbLevel,
00088   const EVerbosityLevel requestedVerbLevel,
00089   const bool isDefaultLevel
00090   )
00091 {
00092   return (
00093     ( as<int>(verbLevel) >= as<int>(requestedVerbLevel) )
00094     ||
00095     ( verbLevel == VERB_DEFAULT && isDefaultLevel )
00096     );
00097 }
00098 
00099 
00100 Teuchos::EVerbosityLevel
00101 Teuchos::incrVerbLevel(
00102   const EVerbosityLevel inputVerbLevel,
00103   const int numLevels
00104   )
00105 {
00106   if (inputVerbLevel == VERB_DEFAULT)
00107     return VERB_DEFAULT;
00108   if (inputVerbLevel == VERB_EXTREME)
00109     return VERB_EXTREME;
00110   const int intVerbLevel = as<int>(inputVerbLevel) + numLevels;
00111   if (intVerbLevel < as<int>(VERB_NONE))
00112     return VERB_NONE;
00113   else if (intVerbLevel > as<int>(VERB_EXTREME))
00114     return VERB_EXTREME;
00115   // If we get here, then intVerbLevel is a valid verbosity level.
00116   return verbLevelArray[intVerbLevel];
00117 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines