CYCLUS
Public Types | Public Member Functions | List of all members
cyclus::toolkit::BasicFunctionFactory Class Reference

Detailed Description

A concrete factory that can provide access to basic symbolic functions.

Definition at line 92 of file symbolic_function_factories.h.

#include <symbolic_function_factories.h>

Public Types

enum  FunctionType { LIN, EXP }
 

Public Member Functions

 BasicFunctionFactory ()
 
SymFunction::Ptr GetFunctionPtr (std::string type, std::string params)
 

Member Enumeration Documentation

The type of functions this factory can provide.

Enumerator
LIN 

See cyclus::toolkit::LinFunctionFactory for a description of function parameters.

EXP 

See cyclus::toolkit::ExpFunctionFactory for a description of function parameters.

Definition at line 95 of file symbolic_function_factories.h.

Constructor & Destructor Documentation

cyclus::toolkit::BasicFunctionFactory::BasicFunctionFactory ( )

Constructor sets up the enum names map.

Definition at line 82 of file symbolic_function_factories.cc.

Member Function Documentation

SymFunction::Ptr cyclus::toolkit::BasicFunctionFactory::GetFunctionPtr ( std::string  type,
std::string  params 
)

Return a function pointer to a registered function type.

Parameters
typethe function type, see BasicFunctionFactory::FunctionType for supported function types. For each supported function type, either the full name or the first three letters are acceptable. For example, for a "linear" function, either "linear" or "lin" are acceptable.
paramsthe function parameters
Returns
the function

Definition at line 92 of file symbolic_function_factories.cc.


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