sb::PluginFunction Class Reference

A plugin function. More...

#include <PluginFunction.hpp>

Inheritance diagram for sb::PluginFunction:

Public Member Functions
virtual void	typecheck (const Schema &arg_types)
	Check to make sure the argument types are valid for this function. More...
virtual void	eval (Tuple &retval, Tuple &args)=0
	Evaluate this function over the arguments and place the return value in retval. More...

Detailed Description

A plugin function.

Member Function Documentation

virtual void sb::PluginFunction::eval ( Tuple &  retval, Tuple &  args  )

pure virtual

Evaluate this function over the arguments and place the return value in retval.

Parameters

retval	Value where the output of this function should be placed. Its type will match the type returned from the typecheck method.
args	Values corresponding to the arguments. Their types will match the types passed to typecheck.

Exceptions

PluginEvalException

if anything goes wrong.

virtual void sb::PluginFunction::typecheck ( const Schema &  arg_types )

inlinevirtual

Check to make sure the argument types are valid for this function.

Parameters

arg_types

The types of the arguments to this function.

Exceptions

TypecheckException

if the argument types are not appropriate.

---

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

• PluginFunction.hpp