Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Teuchos::SimpleModifier Class Reference
Inheritance diagram for Teuchos::SimpleModifier:
Inheritance graph
[legend]

Public Member Functions

 SimpleModifier (const std::string &name)
 
- Public Member Functions inherited from Teuchos::ParameterListModifier
void printDoc (std::string const &docString, std::ostream &out) const
 Print documentation for this parameter list modifier. More...
 
Array< std::string > findMatchingBaseNames (const ParameterList &paramList, const std::string &baseName, const bool &findParameters=true, const bool &findSublists=true) const
 Find the parameters and/or sublists with matching base names. More...
 
virtual void modify (ParameterList &paramList, ParameterList &validParamList) const
 Modify a parameter list and/or the valid parameter list being used to validate it and throw std::exception (with a great error message) if modification fails. More...
 
virtual void reconcile (ParameterList &paramList) const
 Reconcile a parameter list and/or the valid parameter list being used to validate it and throw std::exception (with a great error message) if reconciliation fails. More...
 
int expandParameters (const std::string &paramTemplateName, ParameterList &paramList, ParameterList &validParamList, const Array< std::string > &excludeParameters=Array< std::string >()) const
 Create parameters in the valid parameter list using a template parameter from the valid parameter list and the names of parameters in the list being validated. More...
 
int expandSublists (const std::string &sublistTemplateName, ParameterList &paramList, ParameterList &validParamList, const Array< std::string > &excludeSublists=Array< std::string >()) const
 Create sublists in the valid parameter list using a template parameter from the valid parameter list and the names of sublists in the list being validated. More...
 
int setDefaultsInSublists (const std::string &paramName, ParameterList &paramList, const Array< std::string > &sublistNames, const bool removeParam=true) const
 Copy a parameter into desired sublists. More...
 
int expandSublistsUsingBaseName (const std::string &baseName, ParameterList &paramList, ParameterList &validParamList, const bool &allowBaseName=true) const
 Create sublists in the valid parameter list using a base name and the corresponding sublists in the parameter list being validated. More...
 
 ParameterListModifier ()=default
 Constructor. More...
 
 ParameterListModifier (const std::string &name)
 Constructor that names the modifier. More...
 
virtual ~ParameterListModifier ()
 Destructor. More...
 
ParameterListModifiersetName (const std::string &name)
 Set the name of *this modifier. More...
 
const std::string & getName () const
 Get the name of *this modifier. More...
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream. More...
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream. More...
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes). More...
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label. More...
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject). More...
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject). More...
 

Additional Inherited Members

- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 
- Protected Attributes inherited from Teuchos::ParameterListModifier
std::string name_ = "ANONYMOUS"
 

Detailed Description

Definition at line 187 of file ParameterListModifier_UnitTests.cpp.

Constructor & Destructor Documentation

Teuchos::SimpleModifier::SimpleModifier ( const std::string &  name)
inline

Definition at line 191 of file ParameterListModifier_UnitTests.cpp.


The documentation for this class was generated from the following file: