Maps Validators to integers. More...

#include <Teuchos_ValidatorMaps.hpp>

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 24 of file Teuchos_ValidatorMaps.hpp.

Member Typedef Documentation

◆ ValidatorMap

typedef std::map<ParameterEntryValidator::ValidatorID, RCP<ParameterEntryValidator> > Teuchos::IDtoValidatorMap::ValidatorMap

Definition at line 29 of file Teuchos_ValidatorMaps.hpp.

◆ IDValidatorPair

typedef std::pair<ParameterEntryValidator::ValidatorID, RCP<ParameterEntryValidator> > Teuchos::IDtoValidatorMap::IDValidatorPair

Definition at line 33 of file Teuchos_ValidatorMaps.hpp.

◆ iterator

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

Definition at line 36 of file Teuchos_ValidatorMaps.hpp.

◆ const_iterator

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

Definition at line 39 of file Teuchos_ValidatorMaps.hpp.

Member Function Documentation

◆ insert()

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

inserts an IDValidatorPair into the map.

Definition at line 15 of file Teuchos_ValidatorMaps.cpp.

◆ find()

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 21 of file Teuchos_ValidatorMaps.cpp.

◆ begin()

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

Returns a const_reference to the beginning of the map.

Definition at line 27 of file Teuchos_ValidatorMaps.cpp.

◆ end()

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

Returns a const_reference to the end of the map.

Definition at line 33 of file Teuchos_ValidatorMaps.cpp.

◆ erase()

size_t Teuchos::IDtoValidatorMap::erase ( const ParameterEntryValidator::ValidatorID & x )

inline

removes the specified validator from the map.

Definition at line 59 of file Teuchos_ValidatorMaps.hpp.

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

Public Types

Public Member Functions