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:

Public Member Functions
Overridden from ParameterListAcceptor
RCP< ParameterList >	getNonconstParameterList ()
RCP< ParameterList >	unsetParameterList ()
RCP< const ParameterList >	getParameterList () 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 ParameterList >	getValidParameters () const
	Return a ParameterList containing all of the valid parameters that this->setParameterList(...) will accept, along with any validators. More...
virtual RCP< const DependencySheet >	getDependencies () 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< ParameterList >	getMyNonconstParamList ()
RCP< const ParameterList >	getMyParamList () 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 29 of file Teuchos_ParameterListAcceptorDefaultBase.hpp.

Member Function Documentation

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

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 20 of file Teuchos_ParameterListAcceptorDefaultBase.cpp.

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

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 27 of file Teuchos_ParameterListAcceptorDefaultBase.cpp.

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

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 36 of file Teuchos_ParameterListAcceptorDefaultBase.cpp.

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

inlineprotected

Definition at line 73 of file Teuchos_ParameterListAcceptorDefaultBase.hpp.

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

inlineprotected

Definition at line 83 of file Teuchos_ParameterListAcceptorDefaultBase.hpp.

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

inlineprotected

Definition at line 91 of file Teuchos_ParameterListAcceptorDefaultBase.hpp.

---

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

• Teuchos_ParameterListAcceptorDefaultBase.hpp
• Teuchos_ParameterListAcceptorDefaultBase.cpp