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

Provides ability to lookup FunctionObjectXMLConverters. More...

#include <Teuchos_FunctionObjectXMLConverterDB.hpp>

Private Members

typedef std::map< std::string, RCP< FunctionObjectXMLConverter > > ConverterMap
 convience class.
 
typedef std::pair< std::string, RCP< FunctionObjectXMLConverter > > ConverterPair
 convience typedef.
 
static ConverterMapgetConverterMap ()
 Gets the default converter to be used to convert FunctionObjects.
 

Modifier Functions

static void addConverter (RCP< const FunctionObject > function, RCP< FunctionObjectXMLConverter > converterToAdd)
 Add a converter to the database.
 

Converter Functions

static RCP< const FunctionObjectXMLConvertergetConverter (const FunctionObject &function)
 Get an appropriate FunctionObjectXMLConverter given a FunctionObject.
 
static RCP< const FunctionObjectXMLConvertergetConverter (const XMLObject &xmlObject)
 Get an appropriate FunctionObjectXMLConverter given a XMLObject.
 
static XMLObject convertFunctionObject (RCP< const FunctionObject > function)
 Given a FunctionObject, converts the FunctionObject to XML.
 
static RCP< FunctionObjectconvertXML (const XMLObject &xmlObject)
 Given an XMLObject, converts the XMLObject to a FunctionObject.
 

I/O Functions

static void printKnownConverters (std::ostream &out)
 prints the xml tags associated with all known converters
 

Detailed Description

Provides ability to lookup FunctionObjectXMLConverters.

Definition at line 61 of file Teuchos_FunctionObjectXMLConverterDB.hpp.

Member Typedef Documentation

◆ ConverterMap

convience class.

Definition at line 150 of file Teuchos_FunctionObjectXMLConverterDB.hpp.

◆ ConverterPair

convience typedef.

Definition at line 153 of file Teuchos_FunctionObjectXMLConverterDB.hpp.

Member Function Documentation

◆ addConverter()

void Teuchos::FunctionObjectXMLConverterDB::addConverter ( RCP< const FunctionObject > function,
RCP< FunctionObjectXMLConverter > converterToAdd )
static

Add a converter to the database.

Parameters
functionA dummy FunctionObject representing the type of function this converter will convert.
convertToAddThe converter to add to the database.

Definition at line 51 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

◆ getConverter() [1/2]

RCP< const FunctionObjectXMLConverter > Teuchos::FunctionObjectXMLConverterDB::getConverter ( const FunctionObject & function)
static

Get an appropriate FunctionObjectXMLConverter given a FunctionObject.

Parameters
functionThe FunctionObject for which a converter is desired.
Returns
A converter for the function.

Definition at line 60 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

◆ getConverter() [2/2]

RCP< const FunctionObjectXMLConverter > Teuchos::FunctionObjectXMLConverterDB::getConverter ( const XMLObject & xmlObject)
static

Get an appropriate FunctionObjectXMLConverter given a XMLObject.

Parameters
xmlObjectThe XMLObject for which a converter is desired.
Returns
A converter for the XMLObject.

Definition at line 74 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

◆ convertFunctionObject()

XMLObject Teuchos::FunctionObjectXMLConverterDB::convertFunctionObject ( RCP< const FunctionObject > function)
static

Given a FunctionObject, converts the FunctionObject to XML.

Parameters
functionThe FunctionObject to convert.
Returns
XML representation of the function.

Definition at line 88 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

◆ convertXML()

RCP< FunctionObject > Teuchos::FunctionObjectXMLConverterDB::convertXML ( const XMLObject & xmlObject)
static

Given an XMLObject, converts the XMLObject to a FunctionObject.

Parameters
xmlObjectThe XMLObject to be converted.
Returns
A FunctionObject that was represented by the XML.

Definition at line 94 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

◆ printKnownConverters()

static void Teuchos::FunctionObjectXMLConverterDB::printKnownConverters ( std::ostream & out)
inlinestatic

prints the xml tags associated with all known converters

Parameters
outStream to which tags should be printed.

Definition at line 131 of file Teuchos_FunctionObjectXMLConverterDB.hpp.

◆ getConverterMap()

FunctionObjectXMLConverterDB::ConverterMap & Teuchos::FunctionObjectXMLConverterDB::getConverterMap ( )
staticprivate

Gets the default converter to be used to convert FunctionObjects.

Definition at line 102 of file Teuchos_FunctionObjectXMLConverterDB.cpp.


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