Teuchos - Trilinos Tools Package  Version of the Day
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_iostream_helpers.hpp"
53 
54 
55 namespace Teuchos {
56 
57 
69 };
70 
71 
73 TEUCHOS_ENUM_INPUT_STREAM_OPERATOR(EVerbosityLevel)
74 
75 
76 
80 TEUCHOSCORE_LIB_DLL_EXPORT std::string toString(const EVerbosityLevel verbLevel);
81 
82 
96 TEUCHOSCORE_LIB_DLL_EXPORT bool includesVerbLevel(
97  const EVerbosityLevel verbLevel,
98  const EVerbosityLevel requestedVerbLevel,
99  const bool isDefaultLevel = false
100  );
101 
102 
112 TEUCHOSCORE_LIB_DLL_EXPORT EVerbosityLevel incrVerbLevel(
113  const EVerbosityLevel inputVerbLevel,
114  const int numLevels
115  );
116 
117 
118 } // namespace Teuchos
119 
120 
121 #endif // TEUCHOS_VERBOSITY_LEVEL_HPP
Generate output as defined by the object.
Generate only a minimal amount of output.
Generate no output.
Generate the most output possible.
EVerbosityLevel
Verbosity level.
Generate more output.
Generate a high level 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.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos, as well as a number of utility routines.