Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
List of all members
Teuchos::XMLParameterListWriter Class Reference

Writes a ParameterList to an XML object. More...

#include <Teuchos_XMLParameterListWriter.hpp>

Public Types

typedef std::map< RCP< const ParameterEntry >, ParameterEntry::ParameterEntryID, RCPConstCompEntryIDsMap
 

Constructors

 XMLParameterListWriter ()
 
XMLObject toXML (const ParameterList &p, RCP< const DependencySheet > depSheet=null) const
 
static const std::string & getParameterListTagName ()
 
static const std::string & getNameAttributeName ()
 
static const std::string & getValidatorsTagName ()
 
static const std::string & getDependenciesTagName ()
 
XMLObject convertParameterList (const ParameterList &p, ParameterEntry::ParameterEntryID &idCounter, EntryIDsMap &entryIDsMap, const ValidatortoIDMap &validatorIDsMap) const
 Write the given list to an XML object.

 
XMLObject convertValidators (const ParameterList &p, ValidatortoIDMap &validatorIDsMap) const
 Convert all the validators.
 
XMLObject convertDependencies (RCP< const DependencySheet > depSheet, const EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
 Convert all the dependencies.
 
void buildInitialValidatorMap (const ParameterList &p, ValidatortoIDMap &validatorIDsMap) const
 Builds up the list of validators to be converted.
 

Detailed Description

Writes a ParameterList to an XML object.

Definition at line 64 of file Teuchos_XMLParameterListWriter.hpp.

Member Typedef Documentation

◆ EntryIDsMap

Definition at line 73 of file Teuchos_XMLParameterListWriter.hpp.

Constructor & Destructor Documentation

◆ XMLParameterListWriter()

Teuchos::XMLParameterListWriter::XMLParameterListWriter ( )

Construct a writer

Definition at line 52 of file Teuchos_XMLParameterListWriter.cpp.

Member Function Documentation

◆ toXML()

XMLObject Teuchos::XMLParameterListWriter::toXML ( const ParameterList p,
RCP< const DependencySheet depSheet = null 
) const

Write the given list to an XML object

Definition at line 57 of file Teuchos_XMLParameterListWriter.cpp.

◆ getParameterListTagName()

static const std::string & Teuchos::XMLParameterListWriter::getParameterListTagName ( )
inlinestatic

Definition at line 89 of file Teuchos_XMLParameterListWriter.hpp.

◆ getNameAttributeName()

static const std::string & Teuchos::XMLParameterListWriter::getNameAttributeName ( )
inlinestatic

Definition at line 95 of file Teuchos_XMLParameterListWriter.hpp.

◆ getValidatorsTagName()

static const std::string & Teuchos::XMLParameterListWriter::getValidatorsTagName ( )
inlinestatic

Definition at line 101 of file Teuchos_XMLParameterListWriter.hpp.

◆ getDependenciesTagName()

static const std::string & Teuchos::XMLParameterListWriter::getDependenciesTagName ( )
inlinestatic

Definition at line 107 of file Teuchos_XMLParameterListWriter.hpp.

◆ convertParameterList()

XMLObject Teuchos::XMLParameterListWriter::convertParameterList ( const ParameterList p,
ParameterEntry::ParameterEntryID idCounter,
EntryIDsMap entryIDsMap,
const ValidatortoIDMap validatorIDsMap 
) const
private

Write the given list to an XML object.

Definition at line 121 of file Teuchos_XMLParameterListWriter.cpp.

◆ convertValidators()

XMLObject Teuchos::XMLParameterListWriter::convertValidators ( const ParameterList p,
ValidatortoIDMap validatorIDsMap 
) const
private

Convert all the validators.

Definition at line 105 of file Teuchos_XMLParameterListWriter.cpp.

◆ convertDependencies()

XMLObject Teuchos::XMLParameterListWriter::convertDependencies ( RCP< const DependencySheet depSheet,
const EntryIDsMap entryIDsMap,
ValidatortoIDMap validatorIDsMap 
) const
private

Convert all the dependencies.

Definition at line 156 of file Teuchos_XMLParameterListWriter.cpp.

◆ buildInitialValidatorMap()

void Teuchos::XMLParameterListWriter::buildInitialValidatorMap ( const ParameterList p,
ValidatortoIDMap validatorIDsMap 
) const
private

Builds up the list of validators to be converted.

Definition at line 87 of file Teuchos_XMLParameterListWriter.cpp.


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