Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_ValidatorMaps.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef Teuchos_VALIDATORMAPS_HPP
43 #define Teuchos_VALIDATORMAPS_HPP
44 
51 
52 
53 namespace Teuchos {
54 
55 
58 public:
59 
61  typedef std::map<ParameterEntryValidator::ValidatorID,
63 
65  typedef std::pair<ParameterEntryValidator::ValidatorID,
67 
69  typedef ValidatorMap::iterator iterator;
70 
72  typedef ValidatorMap::const_iterator const_iterator;
73 
75  void insert(IDValidatorPair toInsert);
76 
82  const_iterator find(int id) const;
83 
85  const_iterator begin() const;
86 
88  const_iterator end() const;
89 
91  inline
93  return validatorMap.erase(x);
94  }
95 
96 private:
97 
99 
100 };
101 
102 
105 public:
106 
108  typedef std::map<RCP<const ParameterEntryValidator>, int, RCPComp>
110 
112  typedef std::pair<RCP<const ParameterEntryValidator>, int> ValidatorIDPair;
113 
115  typedef ValidatorMap::iterator iterator;
116 
118  typedef ValidatorMap::const_iterator const_iterator;
119 
122 
124  void insert(RCP<const ParameterEntryValidator> toInsert);
125 
131  const_iterator find(
132  const RCP<const ParameterEntryValidator> validator) const;
133 
135  const_iterator begin() const;
136 
138  const_iterator end() const;
139 
140 private:
141 
143 
144  int counter;
145 
146 };
147 
148 
149 } // namespace Teuchos
150 
151 
152 #endif //Teuchos_VALIDATORMAPS_HPP
std::map< RCP< const ParameterEntryValidator >, int, RCPComp > ValidatorMap
Maps Validators to integers.
size_t erase(const ParameterEntryValidator::ValidatorID &x)
removes the specified validator from the map.
ValidatorMap::const_iterator const_iterator
ValidatorMap::const_iterator const_iterator
Struct for comparing two RCPs. Simply compares the raw pointers contained within the RCPs...
std::pair< RCP< const ParameterEntryValidator >, int > ValidatorIDPair
A class for mapping validators to integers.
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
std::pair< ParameterEntryValidator::ValidatorID, RCP< ParameterEntryValidator > > IDValidatorPair
Smart reference counting pointer class for automatic garbage collection.
ValidatorMap::iterator iterator
std::map< ParameterEntryValidator::ValidatorID, RCP< ParameterEntryValidator > > ValidatorMap
ValidatorMap::iterator iterator