Package jason.stdlib

Class foreach

java.lang.Object

jason.asSemantics.DefaultInternalAction

jason.stdlib.foreach

All Implemented Interfaces:

InternalAction, Serializable

@Manual(literal="for (formula) { plan_body }",
        hint="for all unifications of logical formula, the plan_body is executed",
        argsHint="the formula that when true makes the plan_body be executed",
        argsType="logical formula",
        examples={"for ( vl(X) ) { .print(X); }: print all values of X","for ( .member(X,[a,b,c]) ) { .print(X); }: print all members of the list","for ( .range(I,1,10) ) { .print(I); }: print all values from 1 to 10"},
        seeAlso="")
public class foreach
extends DefaultInternalAction

Internal action: .for(formula) { plan_body }.

Description: Implementation of for. For all unifications of logical formula, the plan_body is executed.

Syntax:

    for ( logical formula ) {
       plan_body
    }
  

Parameters:

• + formula (logical formula): the formula that when true makes the plan_body be executed.
  

Example:

  +event : context
    invalid input: '<'- ....
       for ( vl(X) ) {
          .print(X);     // print all values of X
       }
       for ( .member(X,[a,b,c]) ) {
          .print(X);    // print all members of the list
       }
       for ( .range(I,1,10) ) {
          .print(I);    // print all values from 1 to 10
       }
       ....
  

The unification resulted from the evaluation of the logical formula is used only inside the loop, i.e., the unification after the for is the same as before.

See Also:

• while
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
foreach()

Method Summary

Modifier and Type	Method	Description
protected void	checkArguments(Term[] args)
static InternalAction	create()
Object	execute(TransitionSystem ts, Unifier un, Term[] args)	Executes the internal action.
int	getMaxArgs()
int	getMinArgs()
Term[]	prepareArguments(Literal body, Unifier un)	Prepare body's terms to be used in 'execute', normally it consist of cloning and applying each term

Methods inherited from class jason.asSemantics.DefaultInternalAction

canBeUsedInContext, destroy, suspendIntention

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

foreach

public foreach()

Method Details

create

public static InternalAction create()

prepareArguments

public Term[] prepareArguments(Literal body,
 Unifier un)

Description copied from interface: InternalAction

Prepare body's terms to be used in 'execute', normally it consist of cloning and applying each term

Specified by:

prepareArguments in interface InternalAction

Overrides:

prepareArguments in class DefaultInternalAction

getMinArgs

public int getMinArgs()

Overrides:

getMinArgs in class DefaultInternalAction

getMaxArgs

public int getMaxArgs()

Overrides:

getMaxArgs in class DefaultInternalAction

checkArguments

protected void checkArguments(Term[] args)
                       throws JasonException

Overrides:

checkArguments in class DefaultInternalAction

Throws:

JasonException

execute

public Object execute(TransitionSystem ts,
 Unifier un,
 Term[] args)
               throws Exception

Description copied from interface: InternalAction

Executes the internal action. It should return a Boolean or an Iterator. A true boolean return means that the IA was successfully executed. An Iterator result means that there is more than one answer for this IA (e.g. see member internal action).

Specified by:

execute in interface InternalAction

Overrides:

execute in class DefaultInternalAction

Throws:

Exception