Teuchos - Trilinos Tools Package Version of the Day
Public Member Functions
Teuchos::ParameterListAcceptor Class Reference

Base class objects that can accept a parameter list. More...

#include <Teuchos_ParameterListAcceptor.hpp>

Inheritance diagram for Teuchos::ParameterListAcceptor:
Teuchos::ObjectBuilder< ObjectType > Teuchos::ParameterListAcceptorDefaultBase Teuchos::ParameterListNonAcceptor

List of all members.

Public Member Functions

virtual ~ParameterListAcceptor ()
 
Pure virtual functions that must be overridden in subclasses
virtual void setParameterList (RCP< ParameterList > const &paramList)=0
 Set parameters from a parameter list and return with default values.
virtual RCP< ParameterListgetNonconstParameterList ()=0
 Get the parameter list that was set using setParameterList().
virtual RCP< ParameterListunsetParameterList ()=0
 Unset the parameter list that was set using setParameterList().
Virtual functions with default implementation
virtual RCP< const ParameterListgetParameterList () const
 Get const version of the parameter list that was set using setParameterList().
virtual RCP< const ParameterListgetValidParameters () const
 Return a const parameter list of all of the valid parameters that this->setParameterList(...) will accept.

Detailed Description

Base class objects that can accept a parameter list.

ToDo: Finish Documentation!

Definition at line 43 of file Teuchos_ParameterListAcceptor.hpp.


Constructor & Destructor Documentation

Teuchos::ParameterListAcceptor::~ParameterListAcceptor ( ) [virtual]

Definition at line 37 of file Teuchos_ParameterListAcceptor.cpp.


Member Function Documentation

virtual void Teuchos::ParameterListAcceptor::setParameterList ( RCP< ParameterList > const &  paramList) [pure virtual]

Set parameters from a parameter list and return with default values.

Parameters:
paramList[in] On input contains the parameters set by the client. Note that *paramList may have parameters set to their default values added while the list is being parsed either right away or later.

Preconditions:

  • paramList.get() != NULL

Postconditions:

This is parameter list is "remembered" by *this object until it is unset using unsetParameterList().

Note: When this parameter list is passed in it is assumed that the client has finished setting all of the values that they want to set so that the list is completely ready to read (and be validated) by *this object. If the client is to change this parameter list by adding new options or changing the value of current options, the behavior of *this object is undefined. This is because, the object may read the options from *paramList right away or may wait to read some options until a later time. There should be no expectation that if an option is changed by the client that this will automatically be recognized by *this object. To change even one parameter, this function must be called again, with the entire sublist.

Implemented in Teuchos::ObjectBuilder< ObjectType >, and Teuchos::ParameterListNonAcceptor.

virtual RCP<ParameterList> Teuchos::ParameterListAcceptor::getNonconstParameterList ( ) [pure virtual]

Get the parameter list that was set using setParameterList().

Implemented in Teuchos::ObjectBuilder< ObjectType >, and Teuchos::ParameterListAcceptorDefaultBase.

virtual RCP<ParameterList> Teuchos::ParameterListAcceptor::unsetParameterList ( ) [pure virtual]

Unset the parameter list that was set using setParameterList().

This just means that the parameter list that was set using setParameterList() is detached from this object. This does not mean that the effect of the parameters is undone.

Postconditions:

Implemented in Teuchos::ObjectBuilder< ObjectType >, and Teuchos::ParameterListAcceptorDefaultBase.

Teuchos::RCP< const Teuchos::ParameterList > Teuchos::ParameterListAcceptor::getParameterList ( ) const [virtual]

Get const version of the parameter list that was set using setParameterList().

The default implementation returns:

   return const_cast<ParameterListAcceptor*>(this)->getParameterList();

Reimplemented in Teuchos::ObjectBuilder< ObjectType >, and Teuchos::ParameterListAcceptorDefaultBase.

Definition at line 42 of file Teuchos_ParameterListAcceptor.cpp.

Teuchos::RCP< const Teuchos::ParameterList > Teuchos::ParameterListAcceptor::getValidParameters ( ) const [virtual]

Return a const parameter list of all of the valid parameters that this->setParameterList(...) will accept.

The default implementation returns Teuchos::null.

Reimplemented in Teuchos::ObjectBuilder< ObjectType >, and Teuchos::ParameterListNonAcceptor.

Definition at line 49 of file Teuchos_ParameterListAcceptor.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines