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, RCPComp >	ValidatorMap
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...

Detailed Description

A class for mapping validators to integers.

Definition at line 71 of file Teuchos_ValidatorMaps.hpp.

Member Typedef Documentation

typedef std::map<RCP<const ParameterEntryValidator>, int, RCPComp> Teuchos::ValidatortoIDMap::ValidatorMap

Definition at line 76 of file Teuchos_ValidatorMaps.hpp.

typedef std::pair<RCP<const ParameterEntryValidator>, int> Teuchos::ValidatortoIDMap::ValidatorIDPair

Definition at line 79 of file Teuchos_ValidatorMaps.hpp.

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

Definition at line 82 of file Teuchos_ValidatorMaps.hpp.

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

Definition at line 85 of file Teuchos_ValidatorMaps.hpp.

Constructor & Destructor Documentation

Teuchos::ValidatortoIDMap::ValidatortoIDMap

(

)

Definition at line 39 of file Teuchos_ValidatorMaps.cpp.

Member Function Documentation

void Teuchos::ValidatortoIDMap::insert

(

RCP< const ParameterEntryValidator >

toInsert

)

inserts an IDValidatorPair into the map.

Definition at line 42 of file Teuchos_ValidatorMaps.cpp.

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

ValidatortoIDMap::const_iterator Teuchos::ValidatortoIDMap::begin

(

)

const

Returns a const_reference to the beginning of the map.

Definition at line 59 of file Teuchos_ValidatorMaps.cpp.

ValidatortoIDMap::const_iterator Teuchos::ValidatortoIDMap::end

(

)

const

Returns a const_reference to the end of the map.

Definition at line 65 of file Teuchos_ValidatorMaps.cpp.

---

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

• Teuchos_ValidatorMaps.hpp
• Teuchos_ValidatorMaps.cpp