ddl::mapping::Function Class Reference

Mapping Function base class. More...

#include <mapper_interfaces.h>

Inherits ddl::mapping::MapperElement.

Inherited by ddl::mapping::MapperElementBase< Function >.

Classes
class	Callable
	Function caller. More...
struct	ParameterDescription
	Parameter Description. More...

Public Types
using	Description = std::unordered_map<std::string, ParameterDescription>

Public Member Functions
virtual Description	getDescription () const =0
	Get the parameter descriptions.
virtual std::shared_ptr< Callable >	getCallable () const =0
	Get a Function Callable.
Public Member Functions inherited from ddl::mapping::MapperElement
virtual	~MapperElement ()=default
	DTOR.
virtual const std::string &	getName () const =0
	Get the Name.
virtual const Properties &	getProperties () const =0
	Get the Properties.

Detailed Description

Mapping Function base class.

Member Typedef Documentation

Description

using ddl::mapping::Function::Description = std::unordered_map<std::string, ParameterDescription>

Description definition for the parameters of the function

Member Function Documentation

getCallable()

virtual std::shared_ptr< Callable > ddl::mapping::Function::getCallable ( ) const

pure virtual

Get a Function Callable.

Parameters

function_name

the function name

Returns

std::shared_ptr<const FunctionCaller>

Implemented in ddl::mapping::DDLEnumTableFunction, ddl::mapping::InlinePolynomialFunction, ddl::mapping::PolynomialFunction, ddl::mapping::SimulationTimeFunction, ddl::mapping::TriggerCounterFunction, and ddl::mapping::WasReceivedFunction.

getDescription()

virtual Description ddl::mapping::Function::getDescription ( ) const

pure virtual

Get the parameter descriptions.

Returns

Description

Implemented in ddl::mapping::DDLEnumTableFunction, ddl::mapping::InlinePolynomialFunction, ddl::mapping::PolynomialFunction, ddl::mapping::SimulationTimeFunction, ddl::mapping::TriggerCounterFunction, and ddl::mapping::WasReceivedFunction.

---

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

• include/ddl/mapping/mapper_interfaces.h