Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
List of all members
Teuchos::FunctionObject Class Referenceabstract

A function object represents an arbitrary function. More...

#include <Teuchos_FunctionObject.hpp>

Inheritance diagram for Teuchos::FunctionObject:
Teuchos::Describable Teuchos::LabeledObject Teuchos::SimpleFunctionObject< DependeeType > Teuchos::SimpleFunctionObject< T > Teuchos::SimpleFunctionObject< OperandType > Teuchos::AdditionFunction< OperandType > Teuchos::DivisionFunction< OperandType > Teuchos::MultiplicationFunction< OperandType > Teuchos::SubtractionFunction< OperandType >

XMLSerialiation Functions

virtual std::string getTypeAttributeValue () const =0
 Returns the string to be used for the value of the type attribute when converting the function to XML.
 
static const std::string & getXMLTagName ()
 Returns the name of the XML tag used to indicate a funciton object.
 

Additional Inherited Members

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

Detailed Description

A function object represents an arbitrary function.

Definition at line 59 of file Teuchos_FunctionObject.hpp.

Member Function Documentation

◆ getTypeAttributeValue()

virtual std::string Teuchos::FunctionObject::getTypeAttributeValue ( ) const
pure virtual

Returns the string to be used for the value of the type attribute when converting the function to XML.

Implemented in Teuchos::SubtractionFunction< OperandType >, Teuchos::AdditionFunction< OperandType >, Teuchos::MultiplicationFunction< OperandType >, and Teuchos::DivisionFunction< OperandType >.

◆ getXMLTagName()

static const std::string & Teuchos::FunctionObject::getXMLTagName ( )
inlinestatic

Returns the name of the XML tag used to indicate a funciton object.

Definition at line 74 of file Teuchos_FunctionObject.hpp.


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