Teuchos - Trilinos Tools Package
Version of the Day
Loading...
Searching...
No Matches
parameterlist
src
Teuchos_ParameterListAcceptorHelpers.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
42
43
#include "Teuchos_ParameterListAcceptorHelpers.hpp"
44
#include "Teuchos_ParameterListAcceptor.hpp"
45
#include "
Teuchos_ParameterList.hpp
"
46
47
48
void
Teuchos::printValidParameters
(
const
ParameterListAcceptor
&
paramListAccpetor
,
49
std::ostream &out,
const
bool
showDoc )
50
{
51
typedef
ParameterList::PrintOptions
PLPrintOptions
;
52
paramListAccpetor
.getValidParameters()->print(
53
out,
PLPrintOptions
().indent(2).showTypes(
true
).showDoc(showDoc)
54
);
55
}
Teuchos_ParameterList.hpp
Templated Parameter List class.
Teuchos::ParameterListAcceptor
Interface for objects that can accept a ParameterList.
Definition
Teuchos_ParameterListAcceptor.hpp:152
Teuchos::ParameterList::PrintOptions
Utility class for setting and passing in print options.
Definition
Teuchos_ParameterList.hpp:150
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition
Teuchos_RCPDecl.hpp:429
Teuchos::printValidParameters
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void printValidParameters(const ParameterListAcceptor ¶mListAccpetor, std::ostream &out, const bool showDoc=true)
Pretty print the valid parameters from a ParameterListAccpetor object.
Definition
Teuchos_ParameterListAcceptorHelpers.cpp:48
Generated by
1.10.0