Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::FunctionObjectXMLConverter Class Referenceabstract

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

#include <Teuchos_FunctionObjectXMLConverter.hpp>

Inheritance diagram for Teuchos::FunctionObjectXMLConverter:
Inheritance graph
[legend]

Converter Functions

RCP< FunctionObjectfromXMLtoFunctionObject (const XMLObject &xmlObj) const
 Converts a given XMLObject to a FunctionObject. More...
 
virtual RCP< FunctionObjectconvertXML (const XMLObject &xmlObj) const =0
 Preforms any and all special xml conversion that is specific to a particular FunctionObject. More...
 
XMLObject fromFunctionObjecttoXML (const RCP< const FunctionObject > function) const
 Converters a given FunctionObject to XML. More...
 
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. More...
 

Attribute/Query Functions

static const std::string & getTypeAttributeName ()
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream. More...
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream. More...
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes). More...
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label. More...
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject). More...
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject). More...
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

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 ( )
inlinestatic

Definition at line 111 of file Teuchos_FunctionObjectXMLConverter.hpp.


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