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 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 const parameter list of all of the valid parameters that this->setParameterList(...) will accept.
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] 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 116 of file AlgorithmA.cpp.

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

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

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 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 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 const parameter list of all of the valid parameters that this->setParameterList(...) will accept.

The default implementation returns Teuchos::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