Teuchos - Trilinos Tools Package Version of the Day
Teuchos_ValidatorMaps.hpp
Go to the documentation of this file.
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 #ifndef Teuchos_VALIDATORMAPS_HPP
00043 #define Teuchos_VALIDATORMAPS_HPP
00044 
00049 #include "Teuchos_ParameterEntryValidator.hpp"
00050 #include "Teuchos_ValidatorMaps.hpp"
00051 
00052 
00053 namespace Teuchos {
00054 
00055 
00057 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT IDtoValidatorMap {
00058 public:
00059 
00061   typedef std::map<ParameterEntryValidator::ValidatorID,
00062     RCP<ParameterEntryValidator> > ValidatorMap;
00063 
00065   typedef std::pair<ParameterEntryValidator::ValidatorID, 
00066     RCP<ParameterEntryValidator> > IDValidatorPair;
00067 
00069   typedef ValidatorMap::iterator iterator;
00070 
00072   typedef ValidatorMap::const_iterator const_iterator;
00073 
00075   void insert(IDValidatorPair toInsert);
00076 
00082   const_iterator find(int id) const;
00083 
00085   const_iterator begin() const;
00086 
00088   const_iterator end() const;
00089 
00091   inline
00092   size_t erase(const ParameterEntryValidator::ValidatorID& x){
00093     return validatorMap.erase(x);
00094   }
00095 
00096 private:
00097 
00098   ValidatorMap validatorMap;
00099 
00100 };
00101 
00102 
00104 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ValidatortoIDMap {
00105 public:
00106   
00108   typedef std::map<RCP<const ParameterEntryValidator>, int, RCPComp> 
00109     ValidatorMap;
00110 
00112   typedef std::pair<RCP<const ParameterEntryValidator>, int> ValidatorIDPair;
00113 
00115   typedef ValidatorMap::iterator iterator;
00116 
00118   typedef ValidatorMap::const_iterator const_iterator;
00119 
00121   ValidatortoIDMap();
00122 
00124   void insert(RCP<const ParameterEntryValidator> toInsert);
00125   
00131   const_iterator find(
00132     const RCP<const ParameterEntryValidator> validator) const;
00133   
00135   const_iterator begin() const;
00136 
00138   const_iterator end() const;
00139 
00140 private:
00141 
00142   ValidatorMap validatorMap;
00143 
00144   int counter;
00145 
00146 };
00147 
00148 
00149 } // namespace Teuchos
00150 
00151 
00152 #endif //Teuchos_VALIDATORMAPS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines