Teuchos - Trilinos Tools Package Version of the Day
Public Types | Public Member Functions
Teuchos::IDtoValidatorMap Class Reference

Maps Validators to integers. More...

#include <Teuchos_ValidatorMaps.hpp>

List of all members.

Public Types

typedef std::map
< ParameterEntryValidator::ValidatorID,
RCP< ParameterEntryValidator > > 
ValidatorMap
 
typedef std::pair
< ParameterEntryValidator::ValidatorID,
RCP< ParameterEntryValidator > > 
IDValidatorPair
 
typedef ValidatorMap::iterator iterator
 
typedef
ValidatorMap::const_iterator 
const_iterator
 

Public Member Functions

void insert (IDValidatorPair toInsert)
 inserts an IDValidatorPair into the map.
const_iterator find (int id) const
 Retrieves and iterator to a validator and id based on the id given.
const_iterator begin () const
 Returns a const_reference to the beginning of the map.
const_iterator end () const
 Returns a const_reference to the end of the map.
size_t erase (const ParameterEntryValidator::ValidatorID &x)
 removes the specified validator from the map.

Detailed Description

Maps Validators to integers.

Definition at line 57 of file Teuchos_ValidatorMaps.hpp.


Member Typedef Documentation

Definition at line 62 of file Teuchos_ValidatorMaps.hpp.

Definition at line 66 of file Teuchos_ValidatorMaps.hpp.

typedef ValidatorMap::iterator Teuchos::IDtoValidatorMap::iterator

Definition at line 69 of file Teuchos_ValidatorMaps.hpp.

typedef ValidatorMap::const_iterator Teuchos::IDtoValidatorMap::const_iterator

Definition at line 72 of file Teuchos_ValidatorMaps.hpp.


Member Function Documentation

void Teuchos::IDtoValidatorMap::insert ( IDValidatorPair  toInsert)

inserts an IDValidatorPair into the map.

Definition at line 47 of file Teuchos_ValidatorMaps.cpp.

IDtoValidatorMap::const_iterator Teuchos::IDtoValidatorMap::find ( int  id) const

Retrieves and iterator to a validator and id based on the id given.

If no validator is found that has been mappend to the given id, a reference to the end of the map is returned.

Definition at line 53 of file Teuchos_ValidatorMaps.cpp.

IDtoValidatorMap::const_iterator Teuchos::IDtoValidatorMap::begin ( ) const

Returns a const_reference to the beginning of the map.

Definition at line 59 of file Teuchos_ValidatorMaps.cpp.

IDtoValidatorMap::const_iterator Teuchos::IDtoValidatorMap::end ( ) const

Returns a const_reference to the end of the map.

Definition at line 65 of file Teuchos_ValidatorMaps.cpp.

size_t Teuchos::IDtoValidatorMap::erase ( const ParameterEntryValidator::ValidatorID x) [inline]

removes the specified validator from the map.

Definition at line 92 of file Teuchos_ValidatorMaps.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines