AlgorithmA.hpp

Go to the documentation of this file.
00001 #include "Teuchos_ParameterListAcceptor.hpp"
00002 #include "Teuchos_VerboseObject.hpp"
00003 
00004 #ifndef TEUCHOS_ALGORITHM_A_HPP
00005 #define TEUCHOS_ALGORITHM_A_HPP
00006 
00007 
00008 void someDumbFunction( std::ostream &out, const std::string &indentSpacer );
00009 
00010 
00011 void someLessDumbFunction( std::ostream &out_arg );
00012 
00013 
00014 // This is a typical numerical class that derives from VerboseObject and does
00015 // outputting.  Note that the use of the OSTab class requires initialization
00016 // using VerboseObject::getOSTab(...) which takes care of the hassles and is
00017 // easy to use.
00018 //
00019 // This class also derives from ParameterListAcceptor and uses helper
00020 // functio  ns to read options for VerboseObject from a parameter sublist.
00021 class AlgorithmA
00022   : public Teuchos::VerboseObject<AlgorithmA>,
00023     public Teuchos::ParameterListAcceptor
00024 {
00025 public:
00026 
00027   // Constructor(s)
00028 
00029   AlgorithmA();
00030 
00031   // Overridden from ParameterListAccpetor
00032 
00033   void setParameterList(Teuchos::RCP<Teuchos::ParameterList> const& paramList);
00034 
00035   Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
00036 
00037   Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
00038 
00039   Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
00040 
00041   Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
00042 
00043   // Other functions
00044 
00045   void doAlgorithm();
00046 
00047 private:
00048 
00049   enum EAlgoType { ALGO_BOB, ALGO_JOHN, ALGO_HARRY };
00050 
00051   static const std::string toString( AlgorithmA::EAlgoType algoType );
00052 
00053   Teuchos::RCP<Teuchos::ParameterList> paramList_;
00054   EAlgoType algoType_;
00055   double algoTol_;
00056   
00057 };
00058 
00059 
00060 #endif // TEUCHOS_ALGORITHM_A_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 09:57:27 2011 for Teuchos Package Browser (Single Doxygen Collection) by  doxygen 1.6.3