Teuchos::XMLParameterListReader Class Reference

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

#include <Teuchos_XMLParameterListReader.hpp>

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

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. More...
void	convertValidators (const XMLObject &xml, IDtoValidatorMap &validatorIDsMap) const
	Write the given XML object to appropriate validators. More...
void	convertDependencies (RCP< DependencySheet > depSheet, const XMLObject &xml, const EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
	Write the given XML object to appropriate dependencies. More...
void	testForDuplicateValidatorIDs (ParameterEntryValidator::ValidatorID potentialNewID, const IDtoValidatorMap &currentMap) const
	Tests to see if there are duplicate validator IDs. More...
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. More...

Constructors
	XMLParameterListReader ()

Detailed Description

Writes an XML object to a parameter list.

Definition at line 31 of file Teuchos_XMLParameterListReader.hpp.

Member Typedef Documentation

typedef std::map<ParameterEntry::ParameterEntryID, RCP<ParameterEntry> > Teuchos::XMLParameterListReader::EntryIDsMap

Convenience typedef.

Definition at line 40 of file Teuchos_XMLParameterListReader.hpp.

Constructor & Destructor Documentation

Teuchos::XMLParameterListReader::XMLParameterListReader

(

)

Definition at line 21 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 31 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 66 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 28 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 25 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 133 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 90 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 237 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 227 of file Teuchos_XMLParameterListReader.cpp.

void Teuchos::XMLParameterListReader::insertEntryIntoMap ( const XMLObject &  xmlObj, RCP< ParameterEntry >  entryToInsert, EntryIDsMap &  entryIDsMap  ) const

private

Definition at line 256 of file Teuchos_XMLParameterListReader.cpp.

Member Data Documentation

bool Teuchos::XMLParameterListReader::_allowDuplicateSublists

private

Definition at line 80 of file Teuchos_XMLParameterListReader.hpp.

---

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

• Teuchos_XMLParameterListReader.hpp
• Teuchos_XMLParameterListReader.cpp