Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::SimpleFunctionXMLConverter< OperandType > Class Template Referenceabstract

An xml converter for SimpleFunctionObjects. More...

#include <Teuchos_StandardFunctionObjectXMLConverters.hpp>

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

Public Member Functions

Special Converter Functions
virtual RCP
< SimpleFunctionObject
< OperandType > > 
getSpecificSimpleFunction (OperandType operand) const =0
 Gets the specific SimpleFunction to be returned by this converter when converting from XML. More...
 
virtual void getSpecialSimpleFunctionXMLTraits (const RCP< const SimpleFunctionObject< OperandType > >, XMLObject &) const
 Add and extra XML traits that are specific to a certain FuncitonOjbect when converting that function object to xml. More...
 
Overridden from FunctionObjectXMLConverter
RCP< FunctionObjectconvertXML (const XMLObject &xmlObj) const
 
void convertFunctionObject (const RCP< const FunctionObject > functionObject, XMLObject &xmlObj) const
 
- Public Member Functions inherited from Teuchos::FunctionObjectXMLConverter
RCP< FunctionObjectfromXMLtoFunctionObject (const XMLObject &xmlObj) const
 Converts a given XMLObject to a FunctionObject. More...
 
XMLObject fromFunctionObjecttoXML (const RCP< const FunctionObject > function) const
 Converters a given FunctionObject to XML. More...
 
- 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 Member Functions

Constant Retrieving Functions
static std::string getOperandAttributeName ()
 
- Static Public Member Functions inherited from Teuchos::FunctionObjectXMLConverter
static const std::string & getTypeAttributeName ()
 

Additional Inherited Members

- 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

template<class OperandType>
class Teuchos::SimpleFunctionXMLConverter< OperandType >

An xml converter for SimpleFunctionObjects.

Definition at line 59 of file Teuchos_StandardFunctionObjectXMLConverters.hpp.

Member Function Documentation

template<class OperandType >
virtual RCP<SimpleFunctionObject<OperandType> > Teuchos::SimpleFunctionXMLConverter< OperandType >::getSpecificSimpleFunction ( OperandType  operand) const
pure virtual

Gets the specific SimpleFunction to be returned by this converter when converting from XML.

operand The operand to be used with the SimpleFunction.

Implemented in Teuchos::DivisionFunctionXMLConverter< OperandType >, Teuchos::MultiplicationFunctionXMLConverter< OperandType >, Teuchos::AdditionFunctionXMLConverter< OperandType >, and Teuchos::SubtractionFunctionXMLConverter< OperandType >.

template<class OperandType >
virtual void Teuchos::SimpleFunctionXMLConverter< OperandType >::getSpecialSimpleFunctionXMLTraits ( const RCP< const SimpleFunctionObject< OperandType > >  ,
XMLObject  
) const
inlinevirtual

Add and extra XML traits that are specific to a certain FuncitonOjbect when converting that function object to xml.

Parameters
functionObjectThe function object being convertered.
xmlObjThe XMLObject to which any special traits should be added.

Definition at line 82 of file Teuchos_StandardFunctionObjectXMLConverters.hpp.

template<class OperandType >
RCP< FunctionObject > Teuchos::SimpleFunctionXMLConverter< OperandType >::convertXML ( const XMLObject xmlObj) const
virtual
template<class OperandType >
void Teuchos::SimpleFunctionXMLConverter< OperandType >::convertFunctionObject ( const RCP< const FunctionObject functionObject,
XMLObject xmlObj 
) const
virtual

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