RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > IE > IECSInterfaces > Interfaces

IInterpretedFunction Interface

Defines a function that is accessible within the CLIPS/expert system environment and has been defined in the environment, i.e., a deffunction. An interpreted function is executed interpretively, as opposed to compiled code, by the inference engine. It is made up of statements that may be function calls (to other user functions) or values (which are resolved at execution time). The interpreted function executes until all of its statements are executed or a return function is encountered

Namespace: IECSInterfaces

	Name	Description
	ArgumentCount	Returns the number of calling arguments that have been added to the function
	ArgumentString	Specifies a string representing the arguments needed to call the user function (Inherited from IECSInterfaces.IUserFunction.)
	Argument[Integer]	Returns the argument value at the specified index, the argument value specifies the type of the argument (local variable (dtAtom), variable (dtVariable), or multivariable (dtMultiVariable)) and the name of the variable
	Comment	Returns a comment about the function describing its functionality (Inherited from IECSInterfaces.IUserFunction.)
	FunctionName	Returns the name of the function. This is the string that is used in the actual expert system environment, i.e., how the user calls the function (Inherited from IECSInterfaces.IUserFunction.)
	MaxArgumentCount	Specifies the maximum possible number of arguments that may be passed to the function (Inherited from IECSInterfaces.IUserFunction.)
	MinArgumentCount	Specifies the minimum possible number of arguments that may be passed to the function (Inherited from IECSInterfaces.IUserFunction.)
	Order	Special property needed by the IECS... do not touch
	ReasonerCount	Returns the number of reasoners (IReasoner interface, like TInferenceEngine) that this function is registered with (Inherited from IECSInterfaces.IUserFunction.)
	Reasoner[Integer]	Returns a reasoner (like TInferenceEngine) from the list of reasoners that the function is registered with. If the index is invalid, a EListError exception will occur (Inherited from IECSInterfaces.IUserFunction.)
	StatementCount	Returns the number of statements (actions and values) in the interpreted function
	Statement[Integer]	Returns the action or value at the specified index. Statements act as the "code" of the interpreted function

Top

	Name	Description
	AddArgument(String,TIEType)	Adds a calling argument to the interpreted function, e.g., with a function like 'Distance(x1,x2,y1,y2)', x1, x2, y1, and y2 are all arguments.
	AddReasoner(IReasoner)	Register the user function with the reasoner (TInferenceEngine component) (Inherited from IECSInterfaces.IUserFunction.)
	AddStatement(IFunCall)	Overloaded. Adds a function call to the "code" of the interpreted function. Function calls define the actions to perform when the interpreted function is called by the inference engine.
	AddStatement(IIEValue)	Overloaded. Adds a value to the "code" of the interpreted function. When the interpreted function is executed by the inference engine, the values are resolved (thereby possibly doing something)
	Call(IFunCall,TObject,IIEValue)	Called by the inference engine when it encounters the FunctionName within the Expert system. It provides the functionality of a user function (Inherited from IECSInterfaces.IUserFunction.)
	ClearReasoners	Clear the list of reasoners that the user function is registered with, previously added with the AddReasoner method (Inherited from IECSInterfaces.IUserFunction.)
	DeleteReasoner(Integer)	Overloaded. Delete a reasoner from the function's list of reasoners, which have been added by calling the AddReasoner method. It should also deregister the function with the reasoner using the RemoveUserFunction method of the reasoner (Inherited from IECSInterfaces.IUserFunction.)
	DeleteReasoner(IReasoner)	Overloaded. Delete a reasoner from the function's list of reasoners, which have been added by calling the AddReasoner method. It should also deregister the function with the reasoner using the RemoveUserFunction method of the reasoner (Inherited from IECSInterfaces.IUserFunction.)
	GetArgument(Integer)	Accessor method for the Argument property
	GetArgumentCount	Accessor method for the ArgumentCount property
	GetArgumentString	Accessor method for ArgumentString property (Inherited from IECSInterfaces.IUserFunction.)
	GetComment	Accessor method for Comment property (Inherited from IECSInterfaces.IUserFunction.)
	GetFunctionName	Accessor method for FunctionName property (Inherited from IECSInterfaces.IUserFunction.)
	GetMaxArgumentCount	Accessor method for MaxArgumentCount property (Inherited from IECSInterfaces.IUserFunction.)
	GetMinArgumentCount	Accessor method for MinArgumentCount property (Inherited from IECSInterfaces.IUserFunction.)
	GetOrder	Accessor method for the Order property
	GetReasoner(Integer)	Accessor method for Reasoner property (Inherited from IECSInterfaces.IUserFunction.)
	GetReasonerCount	Accessor method for ReasonerCount property (Inherited from IECSInterfaces.IUserFunction.)
	GetStatement(Integer)	Accessor method for the Statement property
	GetStatementCount	Accessor method for the StatementCount property
	get_Argument(Integer)	Represents method get_Argument(Integer).
	get_ArgumentCount	Represents method get_ArgumentCount.
	get_ArgumentString	Represents method get_ArgumentString. (Inherited from IECSInterfaces.IUserFunction.)
	get_Comment	Represents method get_Comment. (Inherited from IECSInterfaces.IUserFunction.)
	get_FunctionName	Represents method get_FunctionName. (Inherited from IECSInterfaces.IUserFunction.)
	get_MaxArgumentCount	Represents method get_MaxArgumentCount. (Inherited from IECSInterfaces.IUserFunction.)
	get_MinArgumentCount	Represents method get_MinArgumentCount. (Inherited from IECSInterfaces.IUserFunction.)
	get_Order	Represents method get_Order.
	get_Reasoner(Integer)	Represents method get_Reasoner(Integer). (Inherited from IECSInterfaces.IUserFunction.)
	get_ReasonerCount	Represents method get_ReasonerCount. (Inherited from IECSInterfaces.IUserFunction.)
	get_Statement(Integer)	Represents method get_Statement(Integer).
	get_StatementCount	Represents method get_StatementCount.
	IndexOfReasoner(IReasoner)	Returns the index of the specified reasoner in the list of registered reasoners (Inherited from IECSInterfaces.IUserFunction.)
	SetArgumentString(String)	Accessor method for ArgumentString property (Inherited from IECSInterfaces.IUserFunction.)
	SetComment(String)	Accessor method for Comment property (Inherited from IECSInterfaces.IUserFunction.)
	SetFunctionName(TIEName)	Accessor method for FunctionName property (Inherited from IECSInterfaces.IUserFunction.)
	SetMaxArgumentCount(Integer)	Accessor method for MaxArgumentCount property (Inherited from IECSInterfaces.IUserFunction.)
	SetMinArgumentCount(Integer)	Accessor method for MinArgumentCount property (Inherited from IECSInterfaces.IUserFunction.)
	SetOrder(Integer)	Accessor method for the Order property
	set_ArgumentString(String)	Represents method set_ArgumentString(String). (Inherited from IECSInterfaces.IUserFunction.)
	set_Comment(String)	Represents method set_Comment(String). (Inherited from IECSInterfaces.IUserFunction.)
	set_FunctionName(TIEName)	Represents method set_FunctionName(TIEName). (Inherited from IECSInterfaces.IUserFunction.)
	set_MaxArgumentCount(Integer)	Represents method set_MaxArgumentCount(Integer). (Inherited from IECSInterfaces.IUserFunction.)
	set_MinArgumentCount(Integer)	Represents method set_MinArgumentCount(Integer). (Inherited from IECSInterfaces.IUserFunction.)
	set_Order(Integer)	Represents method set_Order(Integer).
	ToString(IReasoner)	Returns a string representation of the user function (or a commented pretty-print if it is not an interpreted function). The syntax of the string representation uses the IReasoner's syntax. (Inherited from IECSInterfaces.IUserFunction.)

Top

RiverSoftAVG Products Help

Reference