Package jason.stdlib

Class kill_agent

java.lang.Object

jason.asSemantics.DefaultInternalAction

jason.stdlib.kill_agent

All Implemented Interfaces:

InternalAction, Serializable

@Manual(literal=".kill_agent(name)",
        hint="kills the agent whose name is given as parameter",
        argsHint="the name of the agent to be killed",
        argsType="atom or string",
        examples=".kill_agent(bob): kills the agent named bob",
        seeAlso={"jason.stdlib.create_agent","jason.stdlib.save_agent","jason.stdlib.stopMAS","jason.runtime.RuntimeServices"})
public class kill_agent
extends DefaultInternalAction

Internal action: .kill_agent.

Description: kills the agent whose name is given as parameter. This is a provisional internal action to be used while more adequate mechanisms for creating and killing agents are being developed. In particular, note that an agent can kill any other agent, without any consideration on permissions, etc.! It is the programmers' responsibility to use this action.

Parameters:

• + name (atom or string): the name of the agent to be killed.
  
• + deadline (number): the given time for the agent finish some intentions before being killed. The signal +jag_shutting_down(T) will be produced so that the agent can prepare itself for the shutdown.
  

Example:

• .kill_agent(bob): kills the agent named bob.

See Also:

• create_agent
• save_agent
• stopMAS
• RuntimeServices
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
kill_agent()

Method Summary

Modifier and Type	Method	Description
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

kill_agent

public kill_agent()

Method Details

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