Teuchos_ParameterEntryValidator.hpp

00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 
00030 #ifndef TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
00031 #define TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
00032 
00033 #include "Teuchos_RCP.hpp"
00034 #include "Teuchos_Array.hpp"
00035 
00036 namespace Teuchos {
00037 
00038 
00039 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00040 class ParameterEntry;
00041 #endif
00042 
00043 
00050 class ParameterEntryValidator {
00051 public:
00052 
00054   virtual ~ParameterEntryValidator() {}
00055 
00067   virtual void printDoc(
00068     std::string         const& docString
00069     ,std::ostream            & out
00070     ) const = 0;
00071 
00080   virtual Teuchos::RCP<const Array<std::string> >
00081   validStringValues() const = 0;
00082 
00094   virtual void validate(
00095     ParameterEntry  const& entry,
00096     std::string const& paramName,
00097     std::string const& sublistName
00098     ) const = 0;
00099 
00113   virtual void validateAndModify(
00114     std::string const& paramName,
00115     std::string const& sublistName,
00116     ParameterEntry * entry
00117     ) const
00118     {
00119       TEST_FOR_EXCEPT(0==entry);
00120       this->validate(*entry,paramName,sublistName);
00121     }
00122   
00123 };
00124 
00125 
00126 } // namespace Teuchos
00127 
00128 
00129 #endif // TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H

Generated on Wed May 12 21:40:32 2010 for Teuchos - Trilinos Tools Package by  doxygen 1.4.7