Package jason.stdlib
Class broadcast
java.lang.Object
jason.asSemantics.DefaultInternalAction
jason.stdlib.broadcast
- All Implemented Interfaces:
InternalAction
,java.io.Serializable
@Manual(literal=".broadcast(performative,content)", hint="broadcasts a message to all known agents", argsHint={"the performative (tell, achieve, askOne,...)","the message content"}, argsType={"atom","literal"}, examples=".broadcast(tell,value(10)): sends value(10) as a \"tell\" message to all known agents in the society", seeAlso={"jason.stdlib.send","jason.stdlib.my_name","jason.stdlib.all_names"}) public class broadcast extends DefaultInternalAction
Internal action: .broadcast
.
Description: broadcasts a message to all known agents.
Parameters:
- + ilf (atom): the illocutionary force of the message (tell,
achieve, ...).
- + message (literal): the content of the message.
Example:
-
.broadcast(tell,value(10))
: sendsvalue(10)
as a "tell" message to all known agents in the society.
- See Also:
send
,my_name
, Serialized Form
-
Constructor Summary
Constructors Constructor Description broadcast()
-
Method Summary
Modifier and Type Method Description boolean
canBeUsedInContext()
Return true if the internal action can be used in plans' contextprotected void
checkArguments(Term[] args)
java.lang.Object
execute(TransitionSystem ts, Unifier un, Term[] args)
Executes the internal action.int
getMaxArgs()
int
getMinArgs()
Methods inherited from class jason.asSemantics.DefaultInternalAction
destroy, prepareArguments, suspendIntention
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
broadcast
public broadcast()
-
-
Method Details
-
getMinArgs
public int getMinArgs()- Overrides:
getMinArgs
in classDefaultInternalAction
-
getMaxArgs
public int getMaxArgs()- Overrides:
getMaxArgs
in classDefaultInternalAction
-
checkArguments
- Overrides:
checkArguments
in classDefaultInternalAction
- Throws:
JasonException
-
canBeUsedInContext
public boolean canBeUsedInContext()Description copied from interface:InternalAction
Return true if the internal action can be used in plans' context- Specified by:
canBeUsedInContext
in interfaceInternalAction
- Overrides:
canBeUsedInContext
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
-