Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
Public Types | Public Member Functions | Private Attributes | List of all members
Teuchos::ValidatortoIDMap Class Reference

A class for mapping validators to integers. More...

#include <Teuchos_ValidatorMaps.hpp>

Public Types

typedef std::map< RCP< const ParameterEntryValidator >, int, RCPCompValidatorMap
 
typedef std::pair< RCP< const ParameterEntryValidator >, int > ValidatorIDPair
 
typedef ValidatorMap::iterator iterator
 
typedef ValidatorMap::const_iterator const_iterator
 

Public Member Functions

 ValidatortoIDMap ()
 
void insert (RCP< const ParameterEntryValidator > toInsert)
 inserts an IDValidatorPair into the map. More...
 
const_iterator find (const RCP< const ParameterEntryValidator > validator) const
 Returns an iterator to the validator and id specified by the validator. More...
 
const_iterator begin () const
 Returns a const_reference to the beginning of the map. More...
 
const_iterator end () const
 Returns a const_reference to the end of the map. More...
 

Private Attributes

ValidatorMap validatorMap
 
int counter
 

Detailed Description

A class for mapping validators to integers.

Definition at line 104 of file Teuchos_ValidatorMaps.hpp.

Member Typedef Documentation

◆ ValidatorMap

Definition at line 109 of file Teuchos_ValidatorMaps.hpp.

◆ ValidatorIDPair

Definition at line 112 of file Teuchos_ValidatorMaps.hpp.

◆ iterator

typedef ValidatorMap::iterator Teuchos::ValidatortoIDMap::iterator

Definition at line 115 of file Teuchos_ValidatorMaps.hpp.

◆ const_iterator

typedef ValidatorMap::const_iterator Teuchos::ValidatortoIDMap::const_iterator

Definition at line 118 of file Teuchos_ValidatorMaps.hpp.

Constructor & Destructor Documentation

◆ ValidatortoIDMap()

Teuchos::ValidatortoIDMap::ValidatortoIDMap ( )

Definition at line 71 of file Teuchos_ValidatorMaps.cpp.

Member Function Documentation

◆ insert()

void Teuchos::ValidatortoIDMap::insert ( RCP< const ParameterEntryValidator toInsert)

inserts an IDValidatorPair into the map.

Definition at line 74 of file Teuchos_ValidatorMaps.cpp.

◆ find()

ValidatortoIDMap::const_iterator Teuchos::ValidatortoIDMap::find ( const RCP< const ParameterEntryValidator validator) const

Returns an iterator to the validator and id specified by the validator.

If no id is found with the associated validator, a reference to the end of the map is returned.

Definition at line 84 of file Teuchos_ValidatorMaps.cpp.

◆ begin()

ValidatortoIDMap::const_iterator Teuchos::ValidatortoIDMap::begin ( ) const

Returns a const_reference to the beginning of the map.

Definition at line 91 of file Teuchos_ValidatorMaps.cpp.

◆ end()

ValidatortoIDMap::const_iterator Teuchos::ValidatortoIDMap::end ( ) const

Returns a const_reference to the end of the map.

Definition at line 97 of file Teuchos_ValidatorMaps.cpp.

Member Data Documentation

◆ validatorMap

ValidatorMap Teuchos::ValidatortoIDMap::validatorMap
private

Definition at line 142 of file Teuchos_ValidatorMaps.hpp.

◆ counter

int Teuchos::ValidatortoIDMap::counter
private

Definition at line 144 of file Teuchos_ValidatorMaps.hpp.


The documentation for this class was generated from the following files: