Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
Teuchos::XMLParameterListWriter Class Reference

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

#include <Teuchos_XMLParameterListWriter.hpp>

Public Member Functions

XMLObject toXML (const ParameterList &p, RCP< const DependencySheet > depSheet=null) const
 

Static Public Member Functions

static const std::string & getParameterListTagName ()
 
static const std::string & getNameAttributeName ()
 
static const std::string & getValidatorsTagName ()
 
static const std::string & getDependenciesTagName ()
 

Private Member Functions

XMLObject convertParameterList (const ParameterList &p, ParameterEntry::ParameterEntryID &idCounter, EntryIDsMap &entryIDsMap, const ValidatortoIDMap &validatorIDsMap) const
 Write the given list to an XML object. More...
 
XMLObject convertValidators (const ParameterList &p, ValidatortoIDMap &validatorIDsMap) const
 Convert all the validators. More...
 
XMLObject convertDependencies (RCP< const DependencySheet > depSheet, const EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
 Convert all the dependencies. More...
 
void buildInitialValidatorMap (const ParameterList &p, ValidatortoIDMap &validatorIDsMap) const
 Builds up the list of validators to be converted. More...
 

Public Types

typedef std::map< RCP< const
ParameterEntry >
, ParameterEntry::ParameterEntryID,
RCPConstComp
EntryIDsMap
 

Constructors

 XMLParameterListWriter ()
 

Detailed Description

Writes a ParameterList to an XML object.

Definition at line 32 of file Teuchos_XMLParameterListWriter.hpp.

Member Typedef Documentation

Definition at line 41 of file Teuchos_XMLParameterListWriter.hpp.

Constructor & Destructor Documentation

Teuchos::XMLParameterListWriter::XMLParameterListWriter ( )

Construct a writer

Definition at line 20 of file Teuchos_XMLParameterListWriter.cpp.

Member Function Documentation

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

Write the given list to an XML object

Definition at line 25 of file Teuchos_XMLParameterListWriter.cpp.

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

Definition at line 57 of file Teuchos_XMLParameterListWriter.hpp.

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

Definition at line 63 of file Teuchos_XMLParameterListWriter.hpp.

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

Definition at line 69 of file Teuchos_XMLParameterListWriter.hpp.

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

Definition at line 75 of file Teuchos_XMLParameterListWriter.hpp.

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 89 of file Teuchos_XMLParameterListWriter.cpp.

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

Convert all the validators.

Definition at line 73 of file Teuchos_XMLParameterListWriter.cpp.

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

Convert all the dependencies.

Definition at line 124 of file Teuchos_XMLParameterListWriter.cpp.

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

Builds up the list of validators to be converted.

Definition at line 55 of file Teuchos_XMLParameterListWriter.cpp.


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