Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_FunctionObject.hpp
Go to the documentation of this file.
1// @HEADER
2// *****************************************************************************
3// Teuchos: Common Tools Package
4//
5// Copyright 2004 NTESS and the Teuchos contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef Teuchos_FUNCTION_OBJECT_H
11#define Teuchos_FUNCTION_OBJECT_H
12
13#include "Teuchos_Describable.hpp"
14
15
21namespace Teuchos{
22
23
27class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT FunctionObject: public Describable {
28
29public:
30
33
37 virtual std::string getTypeAttributeValue() const=0;
38
42 static const std::string& getXMLTagName(){
43 static const std::string funcitonTagName = "Function";
44 return funcitonTagName;
45 }
46
48
49};
50
51
52} // namespace Teuchos
53
54
55#endif
Base class for all objects that can describe themselves.
A function object represents an arbitrary function.
static const std::string & getXMLTagName()
Returns the name of the XML tag used to indicate a funciton object.
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...
Smart reference counting pointer class for automatic garbage collection.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...