AlgorithmA Class Reference

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 54 of file FancyOutputting_test.cpp.


Member Enumeration Documentation

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

Definition at line 82 of file FancyOutputting_test.cpp.


Constructor & Destructor Documentation

AlgorithmA::AlgorithmA (  ) 

Definition at line 117 of file FancyOutputting_test.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 124 of file FancyOutputting_test.cpp.

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

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 156 of file FancyOutputting_test.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 163 of file FancyOutputting_test.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 172 of file FancyOutputting_test.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 179 of file FancyOutputting_test.cpp.

void AlgorithmA::doAlgorithm (  ) 

Definition at line 207 of file FancyOutputting_test.cpp.

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

Definition at line 105 of file FancyOutputting_test.cpp.


Member Data Documentation

Definition at line 86 of file FancyOutputting_test.cpp.

Definition at line 87 of file FancyOutputting_test.cpp.

double AlgorithmA::algoTol_ [private]

Definition at line 88 of file FancyOutputting_test.cpp.


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

Generated on Tue Oct 20 10:14:02 2009 for Teuchos Package Browser (Single Doxygen Collection) by  doxygen 1.6.1