Package jason.stdlib

Class plan_label

java.lang.Object

jason.asSemantics.DefaultInternalAction

jason.stdlib.plan_label

All Implemented Interfaces:

InternalAction, Serializable

@Manual(literal=".plan_label(plan,label)",
        hint="unifies with a plan term representing the plan labeled with the given term within the agent\'s plan library",
        argsHint={"the term representing the plan enclosed by { and }","the label of that plan"},
        argsType={"plan term","structure"},
        examples=".plan_label(P,p1): unifies P with the term representation of the plan labeled p1",
        seeAlso={"jason.stdlib.add_plan","jason.stdlib.plan_label","jason.stdlib.relevant_plans","jason.stdlib.remove_plan"})
public class plan_label
extends DefaultInternalAction

Internal action: .plan_label(P,L).

Description: unifies P with a plan term representing the plan labeled with the term L within the agent's plan library.

Parameters:

• +/- plan (plan term): the term representing the plan, it is a plan enclosed by { and } (e.g. {+!g : vl(X) invalid input: '<'- .print(X)}).
  
• +/- label (structure): the label of that plan.
  

Example:

• .plan_label(P,p1): unifies P with the term representation of the plan labeled p1.

See Also:

• add_plan
• relevant_plans
• relevant_plan
• remove_plan
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
plan_label()

Method Summary

Modifier and Type	Method	Description
static InternalAction	create()
Object	execute(TransitionSystem ts, Unifier un, Term[] args)	Executes the internal action.
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

plan_label

public plan_label()

Method Details

create

public static InternalAction create()

getMinArgs

public int getMinArgs()

Overrides:

getMinArgs in class DefaultInternalAction

getMaxArgs

public int getMaxArgs()

Overrides:

getMaxArgs in class DefaultInternalAction

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