Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Teuchos_VerbosityLevelCommandLineProcessorHelpers.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
42
45#include "Teuchos_Array.hpp"
46#include "Teuchos_Assert.hpp"
48
49
50namespace {
51
52
53using Teuchos::Array;
54using Teuchos::tuple;
55
56
57const Array<Teuchos::EVerbosityLevel>
58verbosityLevelValues = tuple<Teuchos::EVerbosityLevel>(
65 );
66
67
68const Array<std::string>
69verbosityLevelNamesStorage = tuple<std::string>(
76 );
77
78
79Array<const char*> verbosityLevelNames;
80// The above variable is Intialized below in order so that if exceptions are
81// thrown then they will be caught in main()!
82
83
84} // namespace
85
86
87void Teuchos::setVerbosityLevelOption(
88 const std::string &optionName,
89 EVerbosityLevel *verbLevel,
90 const std::string &docString,
91 CommandLineProcessor *clp,
92 const bool required
93 )
94{
95 const int numVerbLevels = implicit_cast<int>(verbosityLevelValues.size());
96
97 if ( !verbosityLevelNames.size() ) {
98 verbosityLevelNames = tuple<const char*>(
99 verbosityLevelNamesStorage[0].c_str(),
100 verbosityLevelNamesStorage[1].c_str(),
101 verbosityLevelNamesStorage[2].c_str(),
102 verbosityLevelNamesStorage[3].c_str(),
103 verbosityLevelNamesStorage[4].c_str(),
104 verbosityLevelNamesStorage[5].c_str()
105 );
106 }
107
108#ifdef TEUCHOS_DEBUG
109 TEUCHOS_ASSERT( optionName.length() );
110 TEUCHOS_ASSERT( verbLevel );
111 TEUCHOS_ASSERT( clp );
112 TEUCHOS_ASSERT( implicit_cast<int>(verbosityLevelNamesStorage.size()) == numVerbLevels );
113 TEUCHOS_ASSERT( implicit_cast<int>(verbosityLevelNames.size()) == numVerbLevels );
114#endif
115 clp->setOption(
116 optionName.c_str(), verbLevel,
117 numVerbLevels, &verbosityLevelValues[0], &verbosityLevelNames[0],
118 docString.c_str(), required
119 );
120}
Templated array class derived from the STL std::vector.
Basic command line parser for input from (argc,argv[])
Replacement for std::vector that is compatible with the Teuchos Memory Management classes.
#define TEUCHOS_ASSERT(assertion_test)
This macro is throws when an assert fails.
std::string toString(const HashSet< Key > &h)
@ 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.