Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_VerbosityLevel.cpp
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
43#include "Teuchos_Array.hpp"
44#include "Teuchos_as.hpp"
45
46
47namespace {
48
49
57 );
58
59
60} // namespace
61
62
63
64std::string Teuchos::toString(const EVerbosityLevel verbLevel)
65{
66 switch (verbLevel) {
67 case VERB_DEFAULT:
68 return "VERB_DEFAULT";
69 case VERB_NONE:
70 return "VERB_NONE";
71 case VERB_LOW:
72 return "VERB_LOW";
73 case VERB_MEDIUM:
74 return "VERB_MEDIUM";
75 case VERB_HIGH:
76 return "VERB_HIGH";
77 case VERB_EXTREME:
78 return "VERB_EXTREME";
79 default:
81 true, std::invalid_argument, "Teuchos::toString(const Teuchos::"
82 "EVerbosityLevel): Input argument " << verbLevel << " has an invalid "
83 "value. Valid values are VERB_DEFAULT=" << VERB_DEFAULT << ", VERB_NONE"
84 "=" << VERB_NONE << ", VERB_LOW=" << VERB_LOW << ", VERB_MEDIUM="
85 << VERB_MEDIUM << ", VERB_HIGH=" << VERB_HIGH << ", AND VERB_EXTREME="
86 << VERB_EXTREME << ".");
87 }
88
89 // NOTE (mfh 15 Sep 2014): Most compilers have figured out that the
90 // return statement below is unreachable. Some older compilers
91 // might not realize this. That's why the return statement was put
92 // there, so that those compilers don't warn that this function
93 // doesn't return a value. If it's a choice between one warning and
94 // another, I would prefer the choice that produces less code and
95 // doesn't have unreachable code (which never gets tested).
96
97 //return ""; // Never get here!
98}
99
100
102 const EVerbosityLevel verbLevel,
104 const bool isDefaultLevel
105 )
106{
107 return (
108 ( as<int>(verbLevel) >= as<int>(requestedVerbLevel) )
109 ||
110 ( verbLevel == VERB_DEFAULT && isDefaultLevel )
111 );
112}
113
114
118 const int numLevels
119 )
120{
122 return VERB_DEFAULT;
124 return VERB_EXTREME;
127 return VERB_NONE;
129 return VERB_EXTREME;
130 // If we get here, then intVerbLevel is a valid verbosity level.
132}
Templated array class derived from the STL std::vector.
Definition of Teuchos::as, for conversions between types.
Smart reference counting pointer class for automatic garbage collection.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
EVerbosityLevel
Verbosity level.
@ VERB_MEDIUM
Generate more output.
@ VERB_HIGH
Generate a high level of output.
@ VERB_EXTREME
Generate the most output possible.
@ VERB_NONE
Generate no output.
@ VERB_DEFAULT
Generate output as defined by the object.
@ VERB_LOW
Generate only a minimal amount of output.
TEUCHOSCORE_LIB_DLL_EXPORT bool includesVerbLevel(const EVerbosityLevel verbLevel, const EVerbosityLevel requestedVerbLevel, const bool isDefaultLevel=false)
Return true if the verbosity level includes the given level.
TEUCHOSCORE_LIB_DLL_EXPORT EVerbosityLevel incrVerbLevel(const EVerbosityLevel inputVerbLevel, const int numLevels)
Return an increased or decreased verbosity level.