Package jason.stdlib

Class succeed_goal

java.lang.Object

jason.asSemantics.DefaultInternalAction

jason.stdlib.succeed_goal

All Implemented Interfaces:

InternalAction, Serializable

Direct Known Subclasses:

done, fail_goal

@Manual(literal=".succeed_goal(goal)",
        hint="remove goals from the agent circumstance as if a plan for such goal had successfully finished",
        argsHint="the goals to be removed",
        argsType="literal",
        examples=".succeed_goal(go(X,3)): stops any attempt to achieve goals such as !go(1,3) as if it had already been achieved",
        seeAlso={"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.fail_goal","jason.stdlib.intention","jason.stdlib.suspend","jason.stdlib.suspended","jason.stdlib.resume"})
public class succeed_goal
extends DefaultInternalAction

Internal action: .succeed_goal(G).

Description: remove goals G from the agent circumstance as if a plan for such goal had successfully finished. G is a goal if there is a triggering event +!G in any plan within any intention; also note that intentions can be suspended hence appearing in E, PA, or PI as well.
The meta-event ^!G[state(finished)] is produced.

Example:

• .succeed_goal(go(X,3)): stops any attempt to achieve goals such as !go(1,3) as if it had already been achieved.

(Note: this internal action was introduced in a DALT 2006 paper, where it was called .dropGoal(G,true).)

See Also:

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

Constructor Summary

Constructors

Constructor	Description
succeed_goal()

Method Summary

Modifier and Type	Method	Description
protected void	checkArguments(Term[] args)
void	drop(TransitionSystem ts, IMCondition c, Unifier un)
void	drop(TransitionSystem ts, Literal l, Unifier un)
int	dropIntention(Intention i, IMCondition c, TransitionSystem ts, Unifier un)
Object	execute(TransitionSystem ts, Unifier un, Term[] args)	Executes the internal action.
int	getMaxArgs()
int	getMinArgs()

Methods inherited from class jason.asSemantics.DefaultInternalAction

canBeUsedInContext, destroy, prepareArguments, suspendIntention

Methods inherited from class java.lang.Object

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

Constructor Details

succeed_goal

public succeed_goal()

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

drop

public void drop(TransitionSystem ts,
 Literal l,
 Unifier un)
          throws Exception

Throws:

Exception

drop

public void drop(TransitionSystem ts,
 IMCondition c,
 Unifier un)
          throws Exception

Throws:

Exception

dropIntention

public int dropIntention(Intention i,
 IMCondition c,
 TransitionSystem ts,
 Unifier un)
                  throws JasonException

Throws:

JasonException