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.cpp
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 
43 
44 namespace Teuchos{
45 
46 
48 {
49  validatorMap.insert(toInsert);
50 }
51 
52 
54 {
55  return validatorMap.find(id);
56 }
57 
58 
60 {
61  return validatorMap.begin();
62 }
63 
64 
66 {
67  return validatorMap.end();
68 }
69 
70 
72 {}
73 
75 {
76  const_iterator result = validatorMap.find(toInsert);
77  if(result == validatorMap.end()){
78  validatorMap.insert(ValidatorIDPair(toInsert, counter));
79  ++counter;
80  }
81 }
82 
83 
85  const RCP<const ParameterEntryValidator> validator) const
86 {
87  return validatorMap.find(validator);
88 }
89 
90 
92 {
93  return validatorMap.begin();
94 }
95 
96 
98 {
99  return validatorMap.end();
100 }
101 
102 
103 } // namespace Teuchos
const_iterator find(int id) const
Retrieves and iterator to a validator and id based on the id given.
ValidatorMap::const_iterator const_iterator
ValidatorMap::const_iterator const_iterator
const_iterator end() const
Returns a const_reference to the end of the map.
std::pair< RCP< const ParameterEntryValidator >, int > ValidatorIDPair
void insert(RCP< const ParameterEntryValidator > toInsert)
inserts an IDValidatorPair into the map.
const_iterator end() const
Returns a const_reference to the end of the map.
const_iterator find(const RCP< const ParameterEntryValidator > validator) const
Returns an iterator to the validator and id specified by the validator.
std::pair< ParameterEntryValidator::ValidatorID, RCP< ParameterEntryValidator > > IDValidatorPair
const_iterator begin() const
Returns a const_reference to the beginning of the map.
Smart reference counting pointer class for automatic garbage collection.
const_iterator begin() const
Returns a const_reference to the beginning of the map.
void insert(IDValidatorPair toInsert)
inserts an IDValidatorPair into the map.