Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_ParameterListAcceptorHelpers.cpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Teuchos: Common Tools Package
4 //
5 // Copyright 2004 NTESS and the Teuchos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
13 
14 
16  std::ostream &out, const bool showDoc )
17 {
19  paramListAccpetor.getValidParameters()->print(
20  out, PLPrintOptions().indent(2).showTypes(true).showDoc(showDoc)
21  );
22 }
Templated Parameter List class.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void printValidParameters(const ParameterListAcceptor &paramListAccpetor, std::ostream &out, const bool showDoc=true)
Pretty print the valid parameters from a ParameterListAccpetor object.
Utility class for setting and passing in print options.
ParameterList::PrintOptions PLPrintOptions
Interface for objects that can accept a ParameterList.
virtual RCP< const ParameterList > getValidParameters() const
Return a ParameterList containing all of the valid parameters that this-&gt;setParameterList(...) will accept, along with any validators.