crp::ExternalFunction Class Reference

Class ExternalFunction encapsulates the external function type as an object. More...

#include <function.h>

Inheritance diagram for crp::ExternalFunction:

Public Member Functions
	ExternalFunction (XMLDataPool *meta_info, MetaFunction function, const SPtr< List > &parameters, std::list< Option > &options, const std::string &type, const std::string &condition="")
	Creates an atomic function from a raw function pointer.
virtual void	destroy ()
	Destroys the current instance.
virtual const std::string	get_type_name ()
	Returns the type of the object.
DPtr	execute (SPtr< List > &arguments, SPtr< List > &options, SPtr< Scope > &scope, Engine *engine) const
	Executes the function.
Protected Attributes
MetaFunction	function
	Function address.

---

Detailed Description

Class ExternalFunction encapsulates the external function type as an object.

---

Constructor & Destructor Documentation

crp::ExternalFunction::ExternalFunction	(	XMLDataPool *	meta_info,
		MetaFunction	function,
		const SPtr< List > &	parameters,
		std::list< Option > &	options,
		const std::string &	type,
		const std::string &	condition = ""
	)

Creates an atomic function from a raw function pointer.

Parameters:

meta_info	Meta info of the function
function	Meta function
parameters	Function parameters
options	Function options
type	Output type
condition	Function execution condition

---

Member Function Documentation

virtual void crp::ExternalFunction::destroy

(

)

[inline, virtual]

Destroys the current instance.

DPtr crp::ExternalFunction::execute	(	SPtr< List > &	arguments,
		SPtr< List > &	options,
		SPtr< Scope > &	scope,
		Engine *	engine
	)		const [virtual]

Executes the function.

Parameters:

arguments	Arguments list
scope	Evaluation scope
engine	Evaluation engine

Returns:

Result of the evaluation

Implements crp::AtomicFunction.

virtual const std::string crp::ExternalFunction::get_type_name

(

)

[inline, virtual]

Returns the type of the object.

Returns:

Type of the object

---

Field Documentation

MetaFunction crp::ExternalFunction::function [protected]

Function address.

---

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

• function.h