Teuchos - Trilinos Tools Package  Version of the Day
List of all members
Teuchos::ParameterListAcceptorDefaultBase Class Reference

Intermediate node base class for objects that accept parameter lists that implements some of the needed behavior automatically. More...

#include <Teuchos_ParameterListAcceptorDefaultBase.hpp>

Inheritance diagram for Teuchos::ParameterListAcceptorDefaultBase:
Teuchos::ParameterListAcceptor Teuchos::ParameterListNonAcceptor

Public Member Functions

Overridden from ParameterListAcceptor
RCP< ParameterListgetNonconstParameterList ()
 
RCP< ParameterListunsetParameterList ()
 
RCP< const ParameterListgetParameterList () const
 
- Public Member Functions inherited from Teuchos::ParameterListAcceptor
virtual ~ParameterListAcceptor ()
 Destructor. More...
 
virtual void setParameterList (const RCP< ParameterList > &paramList)=0
 Set parameters from a parameter list and return with default values. More...
 
virtual RCP< const ParameterListgetValidParameters () const
 Return a ParameterList containing all of the valid parameters that this->setParameterList(...) will accept, along with any validators. More...
 
virtual RCP< const DependencySheetgetDependencies () const
 Rreturn a const DependencySheet of all the dependencies that should be applied to the ParameterList returned by this->getValidParameters(). More...
 

Protected Member Functions

Protected accessors to actual parameter list object.
void setMyParamList (const RCP< ParameterList > &paramList)
 
RCP< ParameterListgetMyNonconstParamList ()
 
RCP< const ParameterListgetMyParamList () const
 

Detailed Description

Intermediate node base class for objects that accept parameter lists that implements some of the needed behavior automatically.

Subclasses just need to implement setParameterList() and getValidParameters(). The underlying parameter list is accessed using the non-virtual protected members setMyParamList() and getMyParamList().

Definition at line 61 of file Teuchos_ParameterListAcceptorDefaultBase.hpp.

Member Function Documentation

◆ getNonconstParameterList()

RCP< ParameterList > Teuchos::ParameterListAcceptorDefaultBase::getNonconstParameterList ( )
virtual

◆ unsetParameterList()

RCP< ParameterList > Teuchos::ParameterListAcceptorDefaultBase::unsetParameterList ( )
virtual

◆ getParameterList()

RCP< const ParameterList > Teuchos::ParameterListAcceptorDefaultBase::getParameterList ( ) const
virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 68 of file Teuchos_ParameterListAcceptorDefaultBase.cpp.

◆ setMyParamList()

void Teuchos::ParameterListAcceptorDefaultBase::setMyParamList ( const RCP< ParameterList > &  paramList)
inlineprotected

◆ getMyNonconstParamList()

RCP< ParameterList > Teuchos::ParameterListAcceptorDefaultBase::getMyNonconstParamList ( )
inlineprotected

◆ getMyParamList()

RCP< const ParameterList > Teuchos::ParameterListAcceptorDefaultBase::getMyParamList ( ) const
inlineprotected

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