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

Writes an XML object to a parameter list. More...

#include <Teuchos_XMLParameterListReader.hpp>

List of all members.

Public Member Functions

RCP< ParameterListtoParameterList (const XMLObject &xml, RCP< DependencySheet > depSheet) const
ParameterList toParameterList (const XMLObject &xml) const
void setAllowsDuplicateSublists (bool policy)
 Set policy regarding duplicated sublists.
bool getAllowsDuplicateSublists () const
 Specifies the current policy regarding duplicated sublists. See setAllowsDuplicateSublists() for more details.

Private Member Functions

void convertParameterList (const XMLObject &xml, RCP< ParameterList > parentList, EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 Write the given XML object to a parameter list along with the validators located in the given map.
void convertValidators (const XMLObject &xml, IDtoValidatorMap &validatorIDsMap) const
 Write the given XML object to appropriate validators.
void convertDependencies (RCP< DependencySheet > depSheet, const XMLObject &xml, const EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 Write the given XML object to appropriate dependencies.
void testForDuplicateValidatorIDs (ParameterEntryValidator::ValidatorID potentialNewID, const IDtoValidatorMap &currentMap) const
 Tests to see if there are duplicate validator IDs.
void insertEntryIntoMap (const XMLObject &xmlObj, RCP< ParameterEntry > entryToInsert, EntryIDsMap &entryIDsMap) const
 

Private Attributes

bool _allowDuplicateSublists

Public Types

typedef std::map
< ParameterEntry::ParameterEntryID,
RCP< ParameterEntry > > 
EntryIDsMap
 Convenience typedef.

Constructors

 XMLParameterListReader ()
 

Detailed Description

Writes an XML object to a parameter list.

Definition at line 63 of file Teuchos_XMLParameterListReader.hpp.


Member Typedef Documentation

Convenience typedef.

Definition at line 72 of file Teuchos_XMLParameterListReader.hpp.


Constructor & Destructor Documentation

Teuchos::XMLParameterListReader::XMLParameterListReader ( )

Definition at line 53 of file Teuchos_XMLParameterListReader.cpp.


Member Function Documentation

RCP< ParameterList > Teuchos::XMLParameterListReader::toParameterList ( const XMLObject xml,
RCP< DependencySheet depSheet 
) const

Write the given XML object to a parameter list

Definition at line 63 of file Teuchos_XMLParameterListReader.cpp.

ParameterList Teuchos::XMLParameterListReader::toParameterList ( const XMLObject xml) const

Write the given XML object to a parameter list

Definition at line 98 of file Teuchos_XMLParameterListReader.cpp.

void Teuchos::XMLParameterListReader::setAllowsDuplicateSublists ( bool  policy)

Set policy regarding duplicated sublists.

The default behavior of this class is to allow duplicated sublists, although the resulting ParameterList is undefined for the duplicated sublists (in most cases, they will be merged in the order they are encountered in the XML character stream).

If set false, then duplicated sublists in the XML tree will result in the Teuchos::DuplicateParameterSublist exception being thrown.

If set true, the default behavior is restored.

Definition at line 60 of file Teuchos_XMLParameterListReader.cpp.

bool Teuchos::XMLParameterListReader::getAllowsDuplicateSublists ( ) const

Specifies the current policy regarding duplicated sublists. See setAllowsDuplicateSublists() for more details.

Definition at line 57 of file Teuchos_XMLParameterListReader.cpp.

void Teuchos::XMLParameterListReader::convertParameterList ( const XMLObject xml,
RCP< ParameterList parentList,
EntryIDsMap entryIDsMap,
const IDtoValidatorMap validatorIDsMap 
) const [private]

Write the given XML object to a parameter list along with the validators located in the given map.

Definition at line 165 of file Teuchos_XMLParameterListReader.cpp.

void Teuchos::XMLParameterListReader::convertValidators ( const XMLObject xml,
IDtoValidatorMap validatorIDsMap 
) const [private]

Write the given XML object to appropriate validators.

Definition at line 122 of file Teuchos_XMLParameterListReader.cpp.

void Teuchos::XMLParameterListReader::convertDependencies ( RCP< DependencySheet depSheet,
const XMLObject xml,
const EntryIDsMap entryIDsMap,
const IDtoValidatorMap validatorIDsMap 
) const [private]

Write the given XML object to appropriate dependencies.

Definition at line 269 of file Teuchos_XMLParameterListReader.cpp.

void Teuchos::XMLParameterListReader::testForDuplicateValidatorIDs ( ParameterEntryValidator::ValidatorID  potentialNewID,
const IDtoValidatorMap currentMap 
) const [private]

Tests to see if there are duplicate validator IDs.

Definition at line 259 of file Teuchos_XMLParameterListReader.cpp.

void Teuchos::XMLParameterListReader::insertEntryIntoMap ( const XMLObject xmlObj,
RCP< ParameterEntry entryToInsert,
EntryIDsMap entryIDsMap 
) const [private]

Definition at line 288 of file Teuchos_XMLParameterListReader.cpp.


Member Data Documentation

Definition at line 112 of file Teuchos_XMLParameterListReader.hpp.


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