Teuchos::FunctionObjectXMLConverterDB Class Reference

Provides ability to lookup FunctionObjectXMLConverters. More...

#include <Teuchos_FunctionObjectXMLConverterDB.hpp>

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

Converter Functions
static RCP< const FunctionObjectXMLConverter >	getConverter (const FunctionObject &function)
	Get an appropriate FunctionObjectXMLConverter given a FunctionObject. More...
static RCP< const FunctionObjectXMLConverter >	getConverter (const XMLObject &xmlObject)
	Get an appropriate FunctionObjectXMLConverter given a XMLObject. More...
static XMLObject	convertFunctionObject (RCP< const FunctionObject > function)
	Given a FunctionObject, converts the FunctionObject to XML. More...
static RCP< FunctionObject >	convertXML (const XMLObject &xmlObject)
	Given an XMLObject, converts the XMLObject to a FunctionObject. More...

I/O Functions
static void	printKnownConverters (std::ostream &out)
	prints the xml tags associated with all known converters More...

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

Detailed Description

Provides ability to lookup FunctionObjectXMLConverters.

Definition at line 28 of file Teuchos_FunctionObjectXMLConverterDB.hpp.

Member Typedef Documentation

typedef std::map<std::string, RCP<FunctionObjectXMLConverter> > Teuchos::FunctionObjectXMLConverterDB::ConverterMap

private

convience class.

Definition at line 117 of file Teuchos_FunctionObjectXMLConverterDB.hpp.

typedef std::pair<std::string, RCP<FunctionObjectXMLConverter> > Teuchos::FunctionObjectXMLConverterDB::ConverterPair

private

convience typedef.

Definition at line 120 of file Teuchos_FunctionObjectXMLConverterDB.hpp.

Member Function Documentation

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

static

Add a converter to the database.

Parameters

function	A dummy FunctionObject representing the type of function this converter will convert.
convertToAdd	The converter to add to the database.

Definition at line 19 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

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

static

Get an appropriate FunctionObjectXMLConverter given a FunctionObject.

Parameters

function

The FunctionObject for which a converter is desired.

Returns

A converter for the function.

Definition at line 28 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

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

static

Get an appropriate FunctionObjectXMLConverter given a XMLObject.

Parameters

xmlObject

The XMLObject for which a converter is desired.

Returns

A converter for the XMLObject.

Definition at line 42 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

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

static

Given a FunctionObject, converts the FunctionObject to XML.

Parameters

function

The FunctionObject to convert.

Returns

XML representation of the function.

Definition at line 56 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

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

static

Given an XMLObject, converts the XMLObject to a FunctionObject.

Parameters

xmlObject

The XMLObject to be converted.

Returns

A FunctionObject that was represented by the XML.

Definition at line 62 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

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

inlinestatic

prints the xml tags associated with all known converters

Parameters

out	Stream to which tags should be printed.

Definition at line 98 of file Teuchos_FunctionObjectXMLConverterDB.hpp.

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

staticprivate

Gets the default converter to be used to convert FunctionObjects.

Definition at line 70 of file Teuchos_FunctionObjectXMLConverterDB.cpp.

---

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

• Teuchos_FunctionObjectXMLConverterDB.hpp
• Teuchos_FunctionObjectXMLConverterDB.cpp