Teuchos - Trilinos Tools Package
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
parameterlist
src
Teuchos_ValidatorMaps.hpp
Go to the documentation of this file.
1
// @HEADER
2
// *****************************************************************************
3
// Teuchos: Common Tools Package
4
//
5
// Copyright 2004 NTESS and the Teuchos contributors.
6
// SPDX-License-Identifier: BSD-3-Clause
7
// *****************************************************************************
8
// @HEADER
9
10
#ifndef Teuchos_VALIDATORMAPS_HPP
11
#define Teuchos_VALIDATORMAPS_HPP
12
15
16
17
#include "Teuchos_ParameterEntryValidator.hpp"
18
19
20
namespace
Teuchos
{
21
22
24
class
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
IDtoValidatorMap
{
25
public
:
26
28
typedef
std::map<
ParameterEntryValidator::ValidatorID
,
29
RCP<ParameterEntryValidator>
>
ValidatorMap
;
30
32
typedef
std::pair<
ParameterEntryValidator::ValidatorID
,
33
RCP<ParameterEntryValidator>
>
IDValidatorPair
;
34
36
typedef
ValidatorMap::iterator
iterator
;
37
39
typedef
ValidatorMap::const_iterator
const_iterator
;
40
42
void
insert
(
IDValidatorPair
toInsert);
43
49
const_iterator
find
(
int
id
)
const
;
50
52
const_iterator
begin
()
const
;
53
55
const_iterator
end
()
const
;
56
58
inline
59
size_t
erase
(
const
ParameterEntryValidator::ValidatorID
& x){
60
return
validatorMap.erase(x);
61
}
62
63
private
:
64
65
ValidatorMap validatorMap;
66
67
};
68
69
71
class
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
ValidatortoIDMap
{
72
public
:
73
75
typedef
std::map<RCP<const ParameterEntryValidator>, int,
RCPComp
>
76
ValidatorMap
;
77
79
typedef
std::pair<RCP<const ParameterEntryValidator>,
int
>
ValidatorIDPair
;
80
82
typedef
ValidatorMap::iterator
iterator
;
83
85
typedef
ValidatorMap::const_iterator
const_iterator
;
86
88
ValidatortoIDMap
();
89
91
void
insert
(
RCP<const ParameterEntryValidator>
toInsert);
92
98
const_iterator
find
(
99
const
RCP<const ParameterEntryValidator>
validator)
const
;
100
102
const_iterator
begin
()
const
;
103
105
const_iterator
end
()
const
;
106
107
private
:
108
109
ValidatorMap
validatorMap;
110
111
int
counter;
112
113
};
114
115
116
}
// namespace Teuchos
117
118
119
#endif
//Teuchos_VALIDATORMAPS_HPP
Teuchos::IDtoValidatorMap
Maps Validators to integers.
Definition
Teuchos_ValidatorMaps.hpp:24
Teuchos::IDtoValidatorMap::end
const_iterator end() const
Returns a const_reference to the end of the map.
Definition
Teuchos_ValidatorMaps.cpp:33
Teuchos::IDtoValidatorMap::begin
const_iterator begin() const
Returns a const_reference to the beginning of the map.
Definition
Teuchos_ValidatorMaps.cpp:27
Teuchos::IDtoValidatorMap::const_iterator
ValidatorMap::const_iterator const_iterator
Definition
Teuchos_ValidatorMaps.hpp:39
Teuchos::IDtoValidatorMap::erase
size_t erase(const ParameterEntryValidator::ValidatorID &x)
removes the specified validator from the map.
Definition
Teuchos_ValidatorMaps.hpp:59
Teuchos::IDtoValidatorMap::IDValidatorPair
std::pair< ParameterEntryValidator::ValidatorID, RCP< ParameterEntryValidator > > IDValidatorPair
Definition
Teuchos_ValidatorMaps.hpp:33
Teuchos::IDtoValidatorMap::ValidatorMap
std::map< ParameterEntryValidator::ValidatorID, RCP< ParameterEntryValidator > > ValidatorMap
Definition
Teuchos_ValidatorMaps.hpp:29
Teuchos::IDtoValidatorMap::iterator
ValidatorMap::iterator iterator
Definition
Teuchos_ValidatorMaps.hpp:36
Teuchos::IDtoValidatorMap::find
const_iterator find(int id) const
Retrieves and iterator to a validator and id based on the id given.
Definition
Teuchos_ValidatorMaps.cpp:21
Teuchos::IDtoValidatorMap::insert
void insert(IDValidatorPair toInsert)
inserts an IDValidatorPair into the map.
Definition
Teuchos_ValidatorMaps.cpp:15
Teuchos::ParameterEntryValidator::ValidatorID
unsigned int ValidatorID
Definition
Teuchos_ParameterEntryValidator.hpp:39
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition
Teuchos_RCPDecl.hpp:397
Teuchos::ValidatortoIDMap::ValidatorIDPair
std::pair< RCP< const ParameterEntryValidator >, int > ValidatorIDPair
Definition
Teuchos_ValidatorMaps.hpp:79
Teuchos::ValidatortoIDMap::end
const_iterator end() const
Returns a const_reference to the end of the map.
Definition
Teuchos_ValidatorMaps.cpp:65
Teuchos::ValidatortoIDMap::insert
void insert(RCP< const ParameterEntryValidator > toInsert)
inserts an IDValidatorPair into the map.
Definition
Teuchos_ValidatorMaps.cpp:42
Teuchos::ValidatortoIDMap::ValidatortoIDMap
ValidatortoIDMap()
Definition
Teuchos_ValidatorMaps.cpp:39
Teuchos::ValidatortoIDMap::ValidatorMap
std::map< RCP< const ParameterEntryValidator >, int, RCPComp > ValidatorMap
Definition
Teuchos_ValidatorMaps.hpp:76
Teuchos::ValidatortoIDMap::const_iterator
ValidatorMap::const_iterator const_iterator
Definition
Teuchos_ValidatorMaps.hpp:85
Teuchos::ValidatortoIDMap::find
const_iterator find(const RCP< const ParameterEntryValidator > validator) const
Returns an iterator to the validator and id specified by the validator.
Definition
Teuchos_ValidatorMaps.cpp:52
Teuchos::ValidatortoIDMap::iterator
ValidatorMap::iterator iterator
Definition
Teuchos_ValidatorMaps.hpp:82
Teuchos::ValidatortoIDMap::begin
const_iterator begin() const
Returns a const_reference to the beginning of the map.
Definition
Teuchos_ValidatorMaps.cpp:59
Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Teuchos::RCPComp
Struct for comparing two RCPs. Simply compares the raw pointers contained within the RCPs.
Definition
Teuchos_RCPDecl.hpp:923
Generated by
1.17.0