Package jason.stdlib

Class suspend

java.lang.Object

jason.asSemantics.DefaultInternalAction

jason.stdlib.suspend

All Implemented Interfaces:

InternalAction, Serializable

@Manual(literal=".suspend[(goal)]",
        hint="suspend goals, i.e., all intentions trying to achieve given goal will stop running until a .resume",
        argsHint="the goals to be suspended [optional]",
        argsType="literal",
        examples={".suspend(go(1,3)): suspends intentions to go to the location 1,3",".suspend: suspends the current intention"},
        seeAlso={"jason.stdlib.suspended","jason.stdlib.intend","jason.stdlib.desire","jason.stdlib.drop_all_desires","jason.stdlib.drop_all_events","jason.stdlib.drop_all_intentions","jason.stdlib.drop_intention","jason.stdlib.drop_desire","jason.stdlib.succeed_goal","jason.stdlib.fail_goal","jason.stdlib.intention","jason.stdlib.resume"})
public class suspend
extends DefaultInternalAction

Internal action: .suspend(G).

Description: suspend goals G, i.e., all intentions trying to achieve G will stop running until the internal action .resume change the state of those intentions. A literal G is a goal if there is a triggering event +!G in any plan within any intention in I, E, PI, or PA.
The meta-event ^!G[state(suspended)] is produced.

Examples:

• .suspend(go(1,3)): suspends intentions to go to the location 1,3.
• .suspend: suspends the current intention.

See Also:

• suspended
• intend
• desire
• drop_all_desires
• drop_all_events
• drop_all_intentions
• drop_intention
• drop_desire
• succeed_goal
• fail_goal
• intention
• resume
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SELF_SUSPENDED_INT
static final String	SUSPENDED_INT

Constructor Summary

Constructors

Constructor	Description
suspend()

Method Summary

Modifier and Type	Method	Description
protected void	checkArguments(Term[] args)
Object	execute(TransitionSystem ts, Unifier un, Term[] args)	Executes the internal action.
int	getMaxArgs()
int	getMinArgs()
boolean	suspendIntention()	Returns true if the internal action (IA) should suspend the intention where the IA is called

Methods inherited from class jason.asSemantics.DefaultInternalAction

canBeUsedInContext, destroy, prepareArguments

Methods inherited from class java.lang.Object

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

Field Details

SUSPENDED_INT

public static final String SUSPENDED_INT

See Also:

• Constant Field Values

SELF_SUSPENDED_INT

public static final String SELF_SUSPENDED_INT

See Also:

• Constant Field Values

Constructor Details

suspend

public suspend()

Method Details

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

suspendIntention

public boolean suspendIntention()

Description copied from interface: InternalAction

Returns true if the internal action (IA) should suspend the intention where the IA is called

Specified by:

suspendIntention in interface InternalAction

Overrides:

suspendIntention in class DefaultInternalAction