Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_VerbosityLevel.hpp
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 
42 #ifndef TEUCHOS_VERBOSITY_LEVEL_HPP
43 #define TEUCHOS_VERBOSITY_LEVEL_HPP
44 
45 
51 #include "Teuchos_Assert.hpp"
52 #include "Teuchos_ArrayView.hpp"
53 #include "Teuchos_iostream_helpers.hpp"
54 
55 
56 namespace Teuchos {
57 
58 
70 };
71 
72 
74 constexpr const int EVerbosityLevel_size = 6;
75 
76 
81 TEUCHOSCORE_LIB_DLL_EXPORT
83 
84 
90 TEUCHOSCORE_LIB_DLL_EXPORT
92 
93 
99 TEUCHOSCORE_LIB_DLL_EXPORT
101 
102 
104 TEUCHOS_ENUM_INPUT_STREAM_OPERATOR(EVerbosityLevel)
105 
106 
107 
111 TEUCHOSCORE_LIB_DLL_EXPORT std::string toString(const EVerbosityLevel verbLevel);
112 
113 
127 TEUCHOSCORE_LIB_DLL_EXPORT bool includesVerbLevel(
128  const EVerbosityLevel verbLevel,
129  const EVerbosityLevel requestedVerbLevel,
130  const bool isDefaultLevel = false
131  );
132 
133 
143 TEUCHOSCORE_LIB_DLL_EXPORT EVerbosityLevel incrVerbLevel(
144  const EVerbosityLevel inputVerbLevel,
145  const int numLevels
146  );
147 
148 
149 } // namespace Teuchos
150 
151 
152 #endif // TEUCHOS_VERBOSITY_LEVEL_HPP
Generate output as defined by the object.
Generate only a minimal amount of output.
Generate no output.
constexpr const int EVerbosityLevel_size
TEUCHOSCORE_LIB_DLL_EXPORT ArrayView< const EVerbosityLevel > getValidVerbLevels()
Generate the most output possible.
EVerbosityLevel
Verbosity level.
Generate more output.
Generate a high level of output.
TEUCHOSCORE_LIB_DLL_EXPORT ArrayView< const char *const > getValidVerbLevelsNamesRawStrings()
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.