Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions | Private Types | Static Private Member Functions | Private Attributes
AlgorithmA Class Reference

#include <AlgorithmA.hpp>

Inheritance diagram for AlgorithmA:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 AlgorithmA ()
void setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
 Set parameters from a parameter list and return with default values.
Teuchos::RCP
< Teuchos::ParameterList
getNonconstParameterList ()
 Get a nonconst version of the parameter list that was set using setParameterList().
Teuchos::RCP
< Teuchos::ParameterList
unsetParameterList ()
 Unset the parameter list that was set using setParameterList().
Teuchos::RCP< const
Teuchos::ParameterList
getParameterList () const
 Get const version of the parameter list that was set using setParameterList().
Teuchos::RCP< const
Teuchos::ParameterList
getValidParameters () const
 Return a ParameterList containing all of the valid parameters that this->setParameterList(...) will accept, along with any validators.
void doAlgorithm ()

Private Types

enum  EAlgoType { ALGO_BOB, ALGO_JOHN, ALGO_HARRY }

Static Private Member Functions

static const std::string toString (AlgorithmA::EAlgoType algoType)

Private Attributes

Teuchos::RCP
< Teuchos::ParameterList
paramList_
EAlgoType algoType_
double algoTol_

Detailed Description

Definition at line 64 of file AlgorithmA.hpp.


Member Enumeration Documentation

enum AlgorithmA::EAlgoType [private]
Enumerator:
ALGO_BOB 
ALGO_JOHN 
ALGO_HARRY 

Definition at line 92 of file AlgorithmA.hpp.


Constructor & Destructor Documentation

AlgorithmA::AlgorithmA ( )

Definition at line 109 of file AlgorithmA.cpp.


Member Function Documentation

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

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

Parameters:
paramList[in/out] On input: contains the parameters set by the client. On output: the same list, possibly filled with default values, depending on the implementation.

Implementations of this method generally read parameters out of paramList, and use them to modify the state or behavior of this object. Implementations may validate input parameters, and throw an exception or set an error state if any of them are invalid. "Validation

Precondition:
! paramList.is_null ()
Postcondition:
this->getParameterList().get() == paramList.get()

This object "remembers" paramList until it is "unset" using unsetParameterList(). When the input ParameterList is passed in, we assume that the client has finished setting parameters in the ParameterList. If the client changes paramList after calling this method, this object's behavior is undefined. This is because the object may read the options from paramList at any time. It may either do so in this method, or it may wait to read them at some later time. Users should not expect that if they change a parameter, that this object will automatically recognize the change. To change even one parameter, this method must be called again.

Implements Teuchos::ParameterListAcceptor.

Definition at line 116 of file AlgorithmA.cpp.

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

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

The returned ParameterList should be the same object (pointer equality) as the object given to setParameterList(). If setParameterList() has not yet been called on this object, the returned RCP may be null, but need not necessarily be. If unsetParameterList()

Implements Teuchos::ParameterListAcceptor.

Definition at line 148 of file AlgorithmA.cpp.

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

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

This does not undo the effect of setting the parameters via a call to setParameterList(). It merely "forgets" the RCP, so that getParameterList() and getNonconstParameterList() both return null.

Postcondition:
this->getParameter().is_null ()
this->getNonconstParameter().is_null ()

Implements Teuchos::ParameterListAcceptor.

Definition at line 155 of file AlgorithmA.cpp.

Teuchos::RCP< const Teuchos::ParameterList > AlgorithmA::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 from Teuchos::ParameterListAcceptor.

Definition at line 164 of file AlgorithmA.cpp.

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

Return a ParameterList containing all of the valid parameters that this->setParameterList(...) will accept, along with any validators.

Implementations of setParameterList() may use the list returned by getValidParameters() to validate the input ParameterList.

The default implementation returns null.

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 171 of file AlgorithmA.cpp.

void AlgorithmA::doAlgorithm ( )

Definition at line 199 of file AlgorithmA.cpp.

const std::string AlgorithmA::toString ( AlgorithmA::EAlgoType  algoType) [static, private]

Definition at line 97 of file AlgorithmA.cpp.


Member Data Documentation

Definition at line 96 of file AlgorithmA.hpp.

Definition at line 97 of file AlgorithmA.hpp.

double AlgorithmA::algoTol_ [private]

Definition at line 98 of file AlgorithmA.hpp.


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