Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Types | Static Private Member Functions | Private Attributes | List of all members
AlgorithmA Class Reference

#include <AlgorithmA.hpp>

Inheritance diagram for AlgorithmA:
Inheritance graph
[legend]

Public Member Functions

 AlgorithmA ()
 
void setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
 Set parameters from a parameter list and return with default values. More...
 
Teuchos::RCP
< Teuchos::ParameterList
getNonconstParameterList ()
 Get a nonconst version of the parameter list that was set using setParameterList(). More...
 
Teuchos::RCP
< Teuchos::ParameterList
unsetParameterList ()
 Unset the parameter list that was set using setParameterList(). More...
 
Teuchos::RCP< const
Teuchos::ParameterList
getParameterList () const
 Get const version of the parameter list that was set using setParameterList(). More...
 
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. More...
 
void doAlgorithm ()
 
- Public Member Functions inherited from Teuchos::VerboseObject< AlgorithmA >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 Constructor: calls initializeVerboseObject(). More...
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 Set this object's verbosity level. More...
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 Set the overriding verbosity level for *this object. More...
 
virtual EVerbosityLevel getVerbLevel () const
 Get the verbosity level. More...
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 Calls initializeVerboseObject(). More...
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 The output stream for *this object. More...
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 Set the overriding the output stream for *this object. More...
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 Set line prefix name for this object. More...
 
virtual RCP< FancyOStreamgetOStream () const
 Return the output stream to be used for out for *this object. More...
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 Return the the overriding output stream if set. More...
 
virtual std::string getLinePrefix () const
 Get the line prefix for this object. More...
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 Create a tab object which sets the number of tabs and optionally the line prefix. More...
 
- Public Member Functions inherited from Teuchos::ParameterListAcceptor
virtual ~ParameterListAcceptor ()
 Destructor. More...
 
virtual RCP< const
DependencySheet
getDependencies () const
 Rreturn a const DependencySheet of all the dependencies that should be applied to the ParameterList returned by this->getValidParameters(). More...
 

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_
 

Additional Inherited Members

- Static Public Member Functions inherited from Teuchos::VerboseObject< AlgorithmA >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 Set the default verbosity level. More...
 
static EVerbosityLevel getDefaultVerbLevel ()
 Get the default verbosity level. More...
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 Set the default output stream object. More...
 
static RCP< FancyOStreamgetDefaultOStream ()
 Get the default output stream object. More...
 
- Protected Member Functions inherited from Teuchos::VerboseObject< AlgorithmA >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 Initialize the VerboseObject. More...
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 Calls initializeVerboseObject(). More...
 
virtual void informUpdatedVerbosityState () const
 Function that is called whenever the verbosity state is updated. More...
 

Detailed Description

Definition at line 30 of file AlgorithmA.hpp.

Member Enumeration Documentation

enum AlgorithmA::EAlgoType
private
Enumerator
ALGO_BOB 
ALGO_JOHN 
ALGO_HARRY 

Definition at line 58 of file AlgorithmA.hpp.

Constructor & Destructor Documentation

AlgorithmA::AlgorithmA ( )

Definition at line 75 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 82 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 114 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 121 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 130 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 137 of file AlgorithmA.cpp.

void AlgorithmA::doAlgorithm ( )

Definition at line 165 of file AlgorithmA.cpp.

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

Definition at line 63 of file AlgorithmA.cpp.

Member Data Documentation

Teuchos::RCP<Teuchos::ParameterList> AlgorithmA::paramList_
private

Definition at line 62 of file AlgorithmA.hpp.

EAlgoType AlgorithmA::algoType_
private

Definition at line 63 of file AlgorithmA.hpp.

double AlgorithmA::algoTol_
private

Definition at line 64 of file AlgorithmA.hpp.


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