Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Teuchos::XMLParameterListReader Class Reference

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

#include <Teuchos_XMLParameterListReader.hpp>

Public Types

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

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. More...
 
bool getAllowsDuplicateSublists () const
 Specifies the current policy regarding duplicated sublists. See setAllowsDuplicateSublists() for more details. 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

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.


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