jadex.bdi.planlib.protocols.AbstractReceiverPlan Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-applications-applib-bdi Show documentation

The Jadex applib BDI package contains ready to use functionalities for BDI agents mostly in form of modules called capabilities.

The newest version!

package jadex.bdi.planlib.protocols;

import jadex.bdiv3.runtime.IGoal;
import jadex.bdiv3x.runtime.IMessageEvent;
import jadex.bdiv3x.runtime.Plan;
import jadex.bridge.fipa.SFipa;

/**
 *  This plan serves as a base class for receiver plans.
 *  It creates the interaction state object and
 *  updates it when the plan terminates.
 */
public abstract class AbstractReceiverPlan extends Plan
{
	//-------- constructors --------
	
	/**
	 *  Initialize the plan
	 */
	public void body()
	{
		// Update interaction state
		if(hasParameter("interaction_state"))
		{
			InteractionState	state	= (InteractionState)getParameter("interaction_state").getValue();
			if(state==null)
			{
				state	= new InteractionState();
				getParameter("interaction_state").setValue(state);
			}
			state.setInteractionState(InteractionState.INTERACTION_RUNNING);
		}

		// Store interaction description
		if(hasParameter("interaction_description") && hasParameter("message"))
		{
			getParameter("interaction_description").setValue(((IMessageEvent)getParameter("message").getValue()).getParameter(SFipa.CONTENT).getValue());
		}
		
		// Create cancel handler
		IGoal	cmhandler	= createGoal("cmcap.cm_handler");
		cmhandler.getParameter("interaction_goal").setValue(getReason());
		dispatchSubgoal(cmhandler);
	}
	
	//-------- methods --------

	/**
	 *  Called when the plan is finished, i.e. when
	 *  the interaction is completed.
	 */
	public void passed()
	{
		if(hasParameter("interaction_state"))
		{
			InteractionState	state	= (InteractionState)getParameter("interaction_state").getValue();
			if(state!=null && InteractionState.INTERACTION_RUNNING.equals(state.getInteractionState()))
			{
				state.setInteractionState(InteractionState.INTERACTION_FINISHED);
			}
		}
	}
	
	/**
	 *  Called when the plan fails, i.e.,
	 *  a problem occurred during protocol execution.
	 */
	public void failed()
	{
		getLogger().severe("Problem during interaction: "+this+", "+getException());
	}
}