Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions | Private Attributes
Teuchos::Foo Class Reference
Inheritance diagram for Teuchos::Foo:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Foo ()
virtual ~Foo ()
virtual std::string getString () const =0
virtual void setDefaults ()=0
void setParameterList (const RCP< ParameterList > &paramList)
 Set parameters from a parameter list and return with default values.
RCP< ParameterListgetNonconstParameterList ()
 Get the parameter list that was set using setParameterList().
RCP< ParameterListunsetParameterList ()
 Unset the parameter list that was set using setParameterList().
RCP< const ParameterListgetParameterList () const
 Get const version of the parameter list that was set using setParameterList().

Private Attributes

RCP< ParameterListparamList_

Detailed Description

Definition at line 39 of file ObjectBuilder_UnitTests.cpp.


Constructor & Destructor Documentation

Teuchos::Foo::Foo ( ) [inline]

Definition at line 41 of file ObjectBuilder_UnitTests.cpp.

virtual Teuchos::Foo::~Foo ( ) [inline, virtual]

Definition at line 42 of file ObjectBuilder_UnitTests.cpp.


Member Function Documentation

virtual std::string Teuchos::Foo::getString ( ) const [pure virtual]

Implemented in Teuchos::FooA, Teuchos::FooB, and Teuchos::FooC.

virtual void Teuchos::Foo::setDefaults ( ) [pure virtual]

Implemented in Teuchos::FooA, Teuchos::FooB, and Teuchos::FooC.

void Teuchos::Foo::setParameterList ( const RCP< ParameterList > &  paramList) [inline, 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.

Implements Teuchos::ParameterListAcceptor.

Definition at line 45 of file ObjectBuilder_UnitTests.cpp.

RCP<ParameterList> Teuchos::Foo::getNonconstParameterList ( ) [inline, virtual]

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 52 of file ObjectBuilder_UnitTests.cpp.

RCP<ParameterList> Teuchos::Foo::unsetParameterList ( ) [inline, 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:

Implements Teuchos::ParameterListAcceptor.

Definition at line 55 of file ObjectBuilder_UnitTests.cpp.

RCP<const ParameterList> Teuchos::Foo::getParameterList ( ) const [inline, virtual]

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

The default implementation returns:

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

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 60 of file ObjectBuilder_UnitTests.cpp.


Member Data Documentation

Definition at line 64 of file ObjectBuilder_UnitTests.cpp.


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