Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_VerbosityLevel.cpp
Go to the documentation of this file.
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_Tuple.hpp"
44 #include "Teuchos_as.hpp"
45 
46 
48 {
50  verbLevelArray = tuple<Teuchos::EVerbosityLevel>(
57  );
58  return verbLevelArray();
59 }
60 
61 
63 {
65  verbLevelNamesArray = tuple<std::string>(
66  "VERB_DEFAULT",
67  "VERB_NONE",
68  "VERB_LOW",
69  "VERB_MEDIUM",
70  "VERB_HIGH",
71  "VERB_EXTREME"
72  );
73  return verbLevelNamesArray();
74 }
75 
76 
78 {
81  verbLevelNamesRawStringsArray;
82  for (int i = 0; i < EVerbosityLevel_size; ++i) {
83  verbLevelNamesRawStringsArray[i] = verbLevelNamesArray[i].c_str();
84  }
85  return verbLevelNamesRawStringsArray();
86 }
87 
88 
89 std::string Teuchos::toString(const EVerbosityLevel verbLevel)
90 {
91  switch (verbLevel) {
92  case VERB_DEFAULT:
93  return "VERB_DEFAULT";
94  case VERB_NONE:
95  return "VERB_NONE";
96  case VERB_LOW:
97  return "VERB_LOW";
98  case VERB_MEDIUM:
99  return "VERB_MEDIUM";
100  case VERB_HIGH:
101  return "VERB_HIGH";
102  case VERB_EXTREME:
103  return "VERB_EXTREME";
104  default:
106  true, std::invalid_argument, "Teuchos::toString(const Teuchos::"
107  "EVerbosityLevel): Input argument " << verbLevel << " has an invalid "
108  "value. Valid values are VERB_DEFAULT=" << VERB_DEFAULT << ", VERB_NONE"
109  "=" << VERB_NONE << ", VERB_LOW=" << VERB_LOW << ", VERB_MEDIUM="
110  << VERB_MEDIUM << ", VERB_HIGH=" << VERB_HIGH << ", AND VERB_EXTREME="
111  << VERB_EXTREME << ".");
112  }
113 
114  // NOTE (mfh 15 Sep 2014): Most compilers have figured out that the
115  // return statement below is unreachable. Some older compilers
116  // might not realize this. That's why the return statement was put
117  // there, so that those compilers don't warn that this function
118  // doesn't return a value. If it's a choice between one warning and
119  // another, I would prefer the choice that produces less code and
120  // doesn't have unreachable code (which never gets tested).
121 
122  //return ""; // Never get here!
123 }
124 
125 
127  const EVerbosityLevel verbLevel,
128  const EVerbosityLevel requestedVerbLevel,
129  const bool isDefaultLevel
130  )
131 {
132  return (
133  ( as<int>(verbLevel) >= as<int>(requestedVerbLevel) )
134  ||
135  ( verbLevel == VERB_DEFAULT && isDefaultLevel )
136  );
137 }
138 
139 
142  const EVerbosityLevel inputVerbLevel,
143  const int numLevels
144  )
145 {
146  if (inputVerbLevel == VERB_DEFAULT)
147  return VERB_DEFAULT;
148  if (inputVerbLevel == VERB_EXTREME)
149  return VERB_EXTREME;
150  const int intVerbLevel = as<int>(inputVerbLevel) + numLevels;
151  if (intVerbLevel < as<int>(VERB_NONE))
152  return VERB_NONE;
153  else if (intVerbLevel > as<int>(VERB_EXTREME))
154  return VERB_EXTREME;
155  // If we get here, then intVerbLevel is a valid verbosity level.
156  return getValidVerbLevels()[intVerbLevel];
157 }
EVerbosityLevel
Verbosity level.
Generate a high level of output.
Generate only a minimal amount of output.
TEUCHOSCORE_LIB_DLL_EXPORT ArrayView< const EVerbosityLevel > getValidVerbLevels()
constexpr const int EVerbosityLevel_size
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
Generate the most output possible.
Statically sized simple array (tuple) class.
std::string toString(const HashSet< Key > &h)
Generate no output.
TEUCHOSCORE_LIB_DLL_EXPORT ArrayView< const std::string > getValidVerbLevelsNames()
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.
Nonowning array view.
Generate more output.
Definition of Teuchos::as, for conversions between types.
Generate output as defined by the object.
TEUCHOSCORE_LIB_DLL_EXPORT ArrayView< const char *const > getValidVerbLevelsNamesRawStrings()