Teuchos - Trilinos Tools Package Version of the Day
Teuchos::FunctionObjectXMLConverter Class Reference

An abstract base class for converting FunctionObjects to and from XML. More...

#include <Teuchos_FunctionObjectXMLConverter.hpp>

Inheritance diagram for Teuchos::FunctionObjectXMLConverter:
Teuchos::Describable Teuchos::LabeledObject Teuchos::SimpleFunctionXMLConverter< OperandType > Teuchos::AdditionFunctionXMLConverter< OperandType > Teuchos::DivisionFunctionXMLConverter< OperandType > Teuchos::MultiplicationFunctionXMLConverter< OperandType > Teuchos::SubtractionFunctionXMLConverter< OperandType >

List of all members.

Public Member Functions

Converter Functions
RCP< FunctionObjectfromXMLtoFunctionObject (const XMLObject &xmlObj) const
 Converts a given XMLObject to a FunctionObject.
virtual RCP< FunctionObjectconvertXML (const XMLObject &xmlObj) const =0
 Preforms any and all special xml conversion that is specific to a particular FunctionObject.
XMLObject fromFunctionObjecttoXML (const RCP< const FunctionObject > function) const
 Converters a given FunctionObject to XML.
virtual void convertFunctionObject (const RCP< const FunctionObject > function, XMLObject &xmlObj) const =0
 Preforms any and all special FunctionObject conversion that is specific to a particlar FunctionObject.

Static Public Member Functions

Attribute/Query Functions
static const std::string & getTypeAttributeName ()
 

Detailed Description

An abstract base class for converting FunctionObjects to and from XML.

Definition at line 64 of file Teuchos_FunctionObjectXMLConverter.hpp.


Member Function Documentation

RCP< FunctionObject > Teuchos::FunctionObjectXMLConverter::fromXMLtoFunctionObject ( const XMLObject xmlObj) const

Converts a given XMLObject to a FunctionObject.

Parameters:
xmlObjThe XMLObject to convert to a FunctionObject.
Returns:
The converted FunctionObject.

Definition at line 47 of file Teuchos_FunctionObjectXMLConverter.cpp.

virtual RCP<FunctionObject> Teuchos::FunctionObjectXMLConverter::convertXML ( const XMLObject xmlObj) const [pure virtual]

Preforms any and all special xml conversion that is specific to a particular FunctionObject.

Parameters:
xmlObjThe xml to be converted.
Returns:
The converted FunctionObject.

Implemented in Teuchos::SimpleFunctionXMLConverter< OperandType >.

XMLObject Teuchos::FunctionObjectXMLConverter::fromFunctionObjecttoXML ( const RCP< const FunctionObject function) const

Converters a given FunctionObject to XML.

Parameters:
functionThe FunctionObject to be converted to XML.
Returns:
An XML representation of the given FunctionObject.

Definition at line 54 of file Teuchos_FunctionObjectXMLConverter.cpp.

virtual void Teuchos::FunctionObjectXMLConverter::convertFunctionObject ( const RCP< const FunctionObject function,
XMLObject xmlObj 
) const [pure virtual]

Preforms any and all special FunctionObject conversion that is specific to a particlar FunctionObject.

Parameters:
functionThe FunctionObject to be converted.
xmlObjThe XMLObject to store all serialization in.

Implemented in Teuchos::SimpleFunctionXMLConverter< OperandType >.

static const std::string& Teuchos::FunctionObjectXMLConverter::getTypeAttributeName ( ) [inline, static]

Definition at line 111 of file Teuchos_FunctionObjectXMLConverter.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines