Teuchos - Trilinos Tools Package Version of the Day
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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 
00043 #ifndef TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
00044 #define TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
00045 
00046 #include "Teuchos_RCP.hpp"
00047 #include "Teuchos_Array.hpp"
00048 #include "Teuchos_XMLObject.hpp"
00049 #include "Teuchos_Describable.hpp"
00050 
00051 namespace Teuchos {
00052 
00053 
00054 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00055 class ParameterEntry;
00056 #endif
00057 
00064 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterEntryValidator : public Describable
00065 {
00066 public:
00067 
00070   
00072   typedef unsigned int ValidatorID;
00073   
00075   typedef RCP<const Array<std::string> > ValidStringsList;
00076 
00078 
00080   ParameterEntryValidator() {}
00081 
00088   virtual const std::string getXMLTypeName() const=0;
00089 
00101   virtual void printDoc(
00102     std::string const& docString,
00103     std::ostream &out
00104     ) const = 0;
00105 
00114   virtual ValidStringsList validStringValues() const = 0;
00115 
00127   virtual void validate(
00128     ParameterEntry  const& entry,
00129     std::string const& paramName,
00130     std::string const& sublistName
00131     ) const = 0;
00132 
00146   virtual void validateAndModify(
00147     std::string const& paramName,
00148     std::string const& sublistName,
00149     ParameterEntry * entry
00150     ) const
00151     {
00152       TEUCHOS_TEST_FOR_EXCEPT(0==entry);
00153       this->validate(*entry,paramName,sublistName);
00154     }
00155 };
00156 
00157 
00158 } // namespace Teuchos
00159 
00160 
00161 #endif // TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines