#include <Teuchos_ParameterListAcceptor.hpp>
Public Member Functions | |
virtual | ~ParameterListAcceptor () |
| |
Pure virtual functions that must be overridden in subclasses | |
virtual void | setParameterList (RCP< ParameterList > const ¶mList)=0 |
Set parameters from a parameter list and return with default values. | |
virtual RCP< ParameterList > | getNonconstParameterList ()=0 |
Get the parameter list that was set using setParameterList() . | |
virtual RCP< ParameterList > | unsetParameterList ()=0 |
Unset the parameter list that was set using setParameterList() . | |
Virtual functions with default implementation | |
virtual RCP< const ParameterList > | getParameterList () const |
Get const version of the parameter list that was set using setParameterList() . | |
virtual RCP< const ParameterList > | getValidParameters () const |
Return a const parameter list of all of the valid parameters that this->setParameterList(...) will accept. |
ToDo: Finish Documentation!
Definition at line 43 of file Teuchos_ParameterListAcceptor.hpp.
Teuchos::ParameterListAcceptor::~ParameterListAcceptor | ( | ) | [virtual] |
virtual RCP<ParameterList> Teuchos::ParameterListAcceptor::getNonconstParameterList | ( | ) | [pure virtual] |
Get the parameter list that was set using setParameterList()
.
Implemented in 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::ParameterListAcceptorDefaultBase.
Definition at line 41 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::ParameterListNonAcceptor.
Definition at line 48 of file Teuchos_ParameterListAcceptor.cpp.
virtual void Teuchos::ParameterListAcceptor::setParameterList | ( | RCP< ParameterList > const & | paramList | ) | [pure virtual] |
Set parameters from a parameter list and return with default values.
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. |
paramList.get() != NULL
Postconditions:
this->getParameterList().get() == paramList.get()
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::ParameterListNonAcceptor.
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:
this->getParameterList().get() == NULL
Implemented in Teuchos::ParameterListAcceptorDefaultBase.