Package jason.stdlib
Class remove_plan
java.lang.Object
jason.asSemantics.DefaultInternalAction
jason.stdlib.remove_plan
- All Implemented Interfaces:
InternalAction
,java.io.Serializable
@Manual(literal=".remove_plan(labels[,source])", hint="removes plans from the agent\'s plan library", argsHint={"the label of the plan to be removed","the source of the plan to be removed (default value is self) [optional]"}, argsType={"structure or list of structures","atom"}, examples={".remove_plan(l1): removes the plan identified by label l1[source(self)]",".remove_plan(l1,bob): removes the plan identified by label l1[source(bob)]. Note this plan was probably added by a tellHow message",".remove_plan([l1,l2,l3]): removes the plans identified by labels l1[source(self)], l2[source(self)], and l3[source(self)]",".remove_plan([l1,l2,l3],bob): removes the plans identified by labels l1[source(bob)], l2[source(bob)], and l3[source(bob)]",".relevant_plans({ +!g }, _, LL); .remove_plan(LL): removes all plans with trigger event +!g"}, seeAlso={"jason.stdlib.add_plan","jason.stdlib.plan_label","jason.stdlib.relevant_plans"}) public class remove_plan extends DefaultInternalAction
Internal action: .remove_plan
.
Description: removes plans from the agent's plan library.
Parameters:
- + label(s) (atom or list of atoms or plan): the label of the plan to be removed. If this parameter is a list of labels, all plans of this list are removed.
- + source (atom [optional]): the source of the
plan to be removed. The default value is
self
.
Examples:
-
.remove_plan(l1)
: removes the plan identified by labell1[source(self)]
. -
.remove_plan(l1,bob)
: removes the plan identified by labell1[source(bob)]
. Note that a plan with a source like that was probably added to the plan library by a tellHow message. -
.remove_plan([l1,l2,l3])
: removes the plans identified by labelsl1[source(self)]
,l2[source(self)]
, andl3[source(self)]
. -
.remove_plan([l1,l2,l3],bob)
: removes the plans identified by labelsl1[source(bob)]
,l2[source(bob)]
, andl3[source(bob)]
. -
.relevant_plans({ +!g }, _, LL); .remove_plan(LL)
: removes all plans with trigger event+!g
. -
for ( .plan_label( P, L[url("file:g.asl")]) ) { .remove_plan(P); }
: removes all achievement plans from source g.asl.
- See Also:
add_plan
,plan_label
,relevant_plans
,relevant_plan
, Serialized Form
-
Constructor Summary
Constructors Constructor Description remove_plan()
-
Method Summary
Modifier and Type Method Description java.lang.Object
execute(TransitionSystem ts, Unifier un, Term[] args)
Executes the internal action.protected Literal
fixLabel(Term label)
int
getMaxArgs()
int
getMinArgs()
Methods inherited from class jason.asSemantics.DefaultInternalAction
canBeUsedInContext, checkArguments, destroy, prepareArguments, suspendIntention
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
remove_plan
public remove_plan()
-
-
Method Details
-
getMinArgs
public int getMinArgs()- Overrides:
getMinArgs
in classDefaultInternalAction
-
getMaxArgs
public int getMaxArgs()- Overrides:
getMaxArgs
in classDefaultInternalAction
-
execute
public java.lang.Object execute(TransitionSystem ts, Unifier un, Term[] args) throws java.lang.ExceptionDescription 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 interfaceInternalAction
- Overrides:
execute
in classDefaultInternalAction
- Throws:
java.lang.Exception
-
fixLabel
- Throws:
jason.asSyntax.parser.ParseException
-