Teuchos::Foo Class Reference

Inheritance diagram for Teuchos::Foo:

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< ParameterList >	getNonconstParameterList ()
	Get the parameter list that was set using setParameterList().
RCP< ParameterList >	unsetParameterList ()
	Unset the parameter list that was set using setParameterList().
RCP< const ParameterList >	getParameterList () const
	Get const version of the parameter list that was set using setParameterList().
Private Attributes
RCP< ParameterList >	paramList_

---

Detailed Description

Definition at line 52 of file ObjectBuilder_UnitTests.cpp.

---

Constructor & Destructor Documentation

Teuchos::Foo::Foo

(

)

[inline]

Definition at line 54 of file ObjectBuilder_UnitTests.cpp.

virtual Teuchos::Foo::~Foo

(

)

[inline, virtual]

Definition at line 55 of file ObjectBuilder_UnitTests.cpp.

---

Member Function Documentation

virtual std::string Teuchos::Foo::getString

(

)

const [pure virtual]

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

virtual void Teuchos::Foo::setDefaults

(

)

[pure virtual]

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

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->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.

Implements Teuchos::ParameterListAcceptor.

Definition at line 58 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 65 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:

• this->getParameterList().get() == NULL

Implements Teuchos::ParameterListAcceptor.

Definition at line 68 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 73 of file ObjectBuilder_UnitTests.cpp.

---

Member Data Documentation

RCP<ParameterList> Teuchos::Foo::paramList_ [private]

Definition at line 77 of file ObjectBuilder_UnitTests.cpp.

---

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

• ObjectBuilder_UnitTests.cpp