Class AtomicFunction is the base interface for ContRap atomic functions. More...

#include <function.h>

Inheritance diagram for crp::AtomicFunction:

Public Member Functions
	AtomicFunction (XMLDataPool *meta_info, SPtr< List > parameters, std::list< Option > &options, const std::string &type, const DPtr &condition=DPtr::bottom)
	Creates a function from code specifications.
std::string	get_name ()
	Returns the name of the function.
XMLDataPool *	get_meta_info ()
	Returns the meta info of the function.
const XMLDataPool *	get_meta_info () const
	Returns the meta info of the function.
const std::string &	get_hash () const
	Returns the hash of the function.
const std::string &	get_key () const
	Returns the key of the function which uniquely identifies the function in ContRap.
virtual Type	get_type () const
	Returns the enumerated type of the object.
virtual DPtr	execute (SPtr< List > &arguments, SPtr< List > &options, SPtr< Scope > &scope, Engine *engine) const =0
	Executes the function.
const SPtr< List > &	get_parameters () const
	Returns the parameters.
const std::list< Option > &	get_options () const
	Returns the options.
const std::string &	get_output_type () const
	Returns the output type.
const std::string &	get_string_condition () const
	Returns the string value of the condition.
const DPtr &	get_condition () const
	Returns the condition.
void	set_condition (const std::string &condition)
	Sets the condition as a string.
void	parse_values (Engine *engine)
	Parses the defaults and conditions.
void	set_loaded (bool status=false)
	Invalidates the function contents.
bool	is_loaded () const
	Returns if the function is valid.
virtual std::string	to_string () const
	Converts the object to a string.
Protected Attributes
XMLDataPool *	meta_info
	Meta info of the function.
SPtr< List >	parameters
	Function parameters.
std::list< Option >	options
	Function options.
std::string	type
	Output type.
DPtr	condition
	Conditions.
std::string	str_condition
	Condition string.
std::string	hash
	Hash.
bool	loaded
	Validity flag.

Detailed Description

Class AtomicFunction is the base interface for ContRap atomic functions.

Constructor & Destructor Documentation

crp::AtomicFunction::AtomicFunction	(	XMLDataPool *	meta_info,
		SPtr< List >	parameters,
		std::list< Option > &	options,
		const std::string &	type,
		const DPtr &	condition = `DPtr::bottom`
	)

Creates a function from code specifications.

Parameters:

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

Member Function Documentation

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

Executes the function.

Parameters:

arguments	Arguments list
scope	Evaluation scope
engine	Evaluation engine

Returns:: Result of the evaluation

Implemented in crp::ExternalFunction, and crp::InternalFunction.

const DPtr& crp::AtomicFunction::get_condition ( ) const [inline]

Returns the condition.

Returns:: Conditions

const std::string& crp::AtomicFunction::get_hash ( ) const [inline]

Returns the hash of the function.

Returns:: Hash of the function

const std::string& crp::AtomicFunction::get_key ( ) const

Returns the key of the function which uniquely identifies the function in ContRap.

Returns:: Key of the function

XMLDataPool* crp::AtomicFunction::get_meta_info ( ) [inline]

Returns the meta info of the function.

Returns:: Meta info

const XMLDataPool* crp::AtomicFunction::get_meta_info ( ) const [inline]

Returns the meta info of the function.

Returns:: Meta info

std::string crp::AtomicFunction::get_name ( )

Returns the name of the function.

Returns:: Function name

const std::list<Option>& crp::AtomicFunction::get_options ( ) const [inline]

Returns the options.

Returns:: Parameter list

const std::string& crp::AtomicFunction::get_output_type ( ) const [inline]

Returns the output type.

Returns:: Output type

const SPtr<List>& crp::AtomicFunction::get_parameters ( ) const [inline]

Returns the parameters.

Returns:: Parameter list

const std::string& crp::AtomicFunction::get_string_condition ( ) const [inline]

Returns the string value of the condition.

This should not be confused with the application of the to_string() method to the evaluated condition pointer. The condition string is set by the library when it loads the function.