jadex.bdi.runtime.interpreter

Class PlanRules

java.lang.Object

jadex.bdi.runtime.interpreter.PlanRules

public class PlanRules
extends Object

Static helper class for plan rules and actions. Plan rules are responsible for: - create a plan body (when lifecycle state = new and processing state = ready -> create plan body) - execute body code (when lifecycle state = body and processing state = ready -> execute body code) - execute passed code (when lifecycle state = passed and processing state = ready -> execute passed code) - execute failed code (when lifecycle state = failed and processing state = ready -> execute failed code) - execute aborted code (when lifecycle state = aborted and processing state = ready -> execute aborted code) - continue plan processing when subgoal finished -> set processing state = ready - removing a plan (when processing state = fishied -> copyback parameters) - abort a plan (when lifecycle state = aborted -> abort subgoals)

Field Summary

Fields

Modifier and Type	Field and Description
static long	TICK_TIMER Tick timer constant.

Constructor Summary

Constructors

Constructor and Description
PlanRules()

Method Summary

Methods

Modifier and Type	Method and Description
static void	abortPlan(jadex.rules.state.IOAVState state, Object rcapa, Object rplan) Abort a plan.
static void	adoptPlan(jadex.rules.state.IOAVState state, Object rcapa, Object rplan) Adopt a plan.
static Object	afterWait(Object wa, boolean[] to, jadex.rules.state.IOAVState state, Object rcapa, Object rplan) Perform the cleanup operations after a wait.
static void	cleanupPlanWait(jadex.rules.state.IOAVState state, Object rcapa, Object rplan, boolean cleanwq) Cleanup plan wait abstraction, waitqueue and wait timer.
static jadex.rules.rulesystem.rules.Rule	createPlanAbortedExecutionRule() Create the plan execution rule.
static jadex.rules.rulesystem.rules.Rule	createPlanBodyExecutionRule() Create the plan execution rule.
static Object[]	createPlanContextInvalidUserRule(Object mplan) Create the plan context invalid rule.
static Object[]	createPlanCreationUserRule(Object mplan) Create the plan creation rule.
static jadex.rules.rulesystem.rules.Rule	createPlanFailedExecutionRule() Create the plan execution rule.
static jadex.rules.rulesystem.rules.Rule	createPlanInstanceAbortRule() Rule to abort a plan when the corresponding goal was deactivated.
static jadex.rules.rulesystem.rules.Rule	createPlanInstanceCleanupFinishedRule() Reactivate a plan when goal cleanup is finished.
static jadex.rules.rulesystem.rules.Rule	createPlanInstanceFactChangedTriggerRule() Trigger plan creation on fact changed event.
static jadex.rules.rulesystem.rules.Rule	createPlanInstanceGoalFinishedRule() Reactivate a plan when the goal it waits for is finished.
static jadex.rules.rulesystem.rules.Rule	createPlanInstanceMaintainGoalFinishedRule() Create the plan instance maintain goal finished rule.
static jadex.rules.rulesystem.rules.Rule	createPlanPassedExecutionRule() Create the plan execution rule.
static jadex.rules.rulesystem.rules.Rule	createPlanRemovalRule() Create the plan removal rule.
static jadex.rules.rulesystem.rules.Rule	createPlanWaitqueueGoalFinishedRule() Add a goal to the waitqueue of a plan when the goal it waits for is finished.
static void	doWait(jadex.rules.state.IOAVState state, Object rplan) Do the waiting, i.e. set the external caller thread to sleep mode.
static void	endPlanPart(jadex.rules.state.IOAVState state, Object rcapa, Object rplan, boolean cleanupwq) End a part (i.e. body/passed/failed/aborted) of a plan.
static Object[]	initializeWait(Object wa, long timeout, jadex.rules.state.IOAVState state, Object rcapa, Object rplan) Initialize the wait by a) check if one of goals is already finished.
static Object	instantiatePlan(jadex.rules.state.IOAVState state, Object rcap, Object mplan, Object cplan, Object reason, Collection preparams, Map bindings, OAVBDIFetcher fetcher) Instantiate a plan.
static Object	waitForWaitAbstraction(Object wa, long timeout, jadex.rules.state.IOAVState state, Object rcapa, Object rplan) Wait for a wait abstraction.

Methods inherited from class java.lang.Object

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

Field Detail

TICK_TIMER

public static final long TICK_TIMER

Tick timer constant.

See Also:

Constant Field Values

Constructor Detail

PlanRules

public PlanRules()

Method Detail

adoptPlan

public static void adoptPlan(jadex.rules.state.IOAVState state,
             Object rcapa,
             Object rplan)

Adopt a plan. Adds the plan to the state (planbase).

Parameters:

state - The state

rcapa - The capability.

rgoal - The goal.

instantiatePlan

public static Object instantiatePlan(jadex.rules.state.IOAVState state,
                     Object rcap,
                     Object mplan,
                     Object cplan,
                     Object reason,
                     Collection preparams,
                     Map bindings,
                     OAVBDIFetcher fetcher)

Instantiate a plan.

Parameters:

state - The state

rcap - The capability.

mplan - The plan model.

cplan - The plan configuration (if any).

preparams - From outside supplied parameter values.

Returns:

The plan instance.

abortPlan

public static void abortPlan(jadex.rules.state.IOAVState state,
             Object rcapa,
             Object rplan)

Abort a plan.

endPlanPart

public static void endPlanPart(jadex.rules.state.IOAVState state,
               Object rcapa,
               Object rplan,
               boolean cleanupwq)

End a part (i.e. body/passed/failed/aborted) of a plan. Cleanup wait abstraction and timers and drop all subgoals. Use cleanupwq flag to also remove elements from the waitqueue, when this is the final part of the plan (passed/failed/aborted).

createPlanBodyExecutionRule

public static jadex.rules.rulesystem.rules.Rule createPlanBodyExecutionRule()

Create the plan execution rule.

createPlanPassedExecutionRule

public static jadex.rules.rulesystem.rules.Rule createPlanPassedExecutionRule()

Create the plan execution rule.

createPlanFailedExecutionRule

public static jadex.rules.rulesystem.rules.Rule createPlanFailedExecutionRule()

Create the plan execution rule.

createPlanAbortedExecutionRule

public static jadex.rules.rulesystem.rules.Rule createPlanAbortedExecutionRule()

Create the plan execution rule.

createPlanInstanceCleanupFinishedRule

public static jadex.rules.rulesystem.rules.Rule createPlanInstanceCleanupFinishedRule()

Reactivate a plan when goal cleanup is finished.

createPlanInstanceGoalFinishedRule

public static jadex.rules.rulesystem.rules.Rule createPlanInstanceGoalFinishedRule()

Reactivate a plan when the goal it waits for is finished.

createPlanWaitqueueGoalFinishedRule

public static jadex.rules.rulesystem.rules.Rule createPlanWaitqueueGoalFinishedRule()

Add a goal to the waitqueue of a plan when the goal it waits for is finished.

createPlanInstanceMaintainGoalFinishedRule

public static jadex.rules.rulesystem.rules.Rule createPlanInstanceMaintainGoalFinishedRule()

Create the plan instance maintain goal finished rule.

createPlanRemovalRule

public static jadex.rules.rulesystem.rules.Rule createPlanRemovalRule()

Create the plan removal rule. Removes a plan from its capability, when execution has finished.

createPlanInstanceAbortRule

public static jadex.rules.rulesystem.rules.Rule createPlanInstanceAbortRule()

Rule to abort a plan when the corresponding goal was deactivated.

createPlanCreationUserRule

public static Object[] createPlanCreationUserRule(Object mplan)

Create the plan creation rule.

Parameters:

usercond - The ADF part of the target condition.

mplan - The plan model element.

createPlanInstanceFactChangedTriggerRule

public static jadex.rules.rulesystem.rules.Rule createPlanInstanceFactChangedTriggerRule()

Trigger plan creation on fact changed event.

createPlanContextInvalidUserRule

public static Object[] createPlanContextInvalidUserRule(Object mplan)

Create the plan context invalid rule.

Parameters:

usercond - The ADF part of the target condition.

mplan - The plan model element.

waitForWaitAbstraction

public static Object waitForWaitAbstraction(Object wa,
                            long timeout,
                            jadex.rules.state.IOAVState state,
                            Object rcapa,
                            Object rplan)

Wait for a wait abstraction.

Returns:

The dispatched element.

initializeWait

public static Object[] initializeWait(Object wa,
                      long timeout,
                      jadex.rules.state.IOAVState state,
                      Object rcapa,
                      Object rplan)

Initialize the wait by a) check if one of goals is already finished. b) set the waitabstraction for the plan. c) set the timer.

doWait

public static void doWait(jadex.rules.state.IOAVState state,
          Object rplan)

Do the waiting, i.e. set the external caller thread to sleep mode.

afterWait

public static Object afterWait(Object wa,
               boolean[] to,
               jadex.rules.state.IOAVState state,
               Object rcapa,
               Object rplan)

Perform the cleanup operations after a wait. Mainly removes the wait abstraction and generates the result.

cleanupPlanWait

public static void cleanupPlanWait(jadex.rules.state.IOAVState state,
                   Object rcapa,
                   Object rplan,
                   boolean cleanwq)

Cleanup plan wait abstraction, waitqueue and wait timer.

Parameters:

rplan - The plan to clean up.

cleanwq - Flag indicating if waitqueue should be cleaned.