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

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

#include <Teuchos_ValidatorMaps.hpp>

List of all members.

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.
const_iterator find (const RCP< const ParameterEntryValidator > validator) const
 Returns an iterator to the validator and id specified by the validator.
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.

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

Definition at line 109 of file Teuchos_ValidatorMaps.hpp.

Definition at line 112 of file Teuchos_ValidatorMaps.hpp.

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

Definition at line 115 of file Teuchos_ValidatorMaps.hpp.

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

Definition at line 118 of file Teuchos_ValidatorMaps.hpp.


Constructor & Destructor Documentation

Teuchos::ValidatortoIDMap::ValidatortoIDMap ( )

Definition at line 71 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 74 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 84 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 91 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 97 of file Teuchos_ValidatorMaps.cpp.


Member Data Documentation

Definition at line 142 of file Teuchos_ValidatorMaps.hpp.

Definition at line 144 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