io.sarl.core

Class AgentTask

java.lang.Object

io.sarl.lang.core.SRESpecificDataContainer

io.sarl.core.AgentTask

public class AgentTask
extends SRESpecificDataContainer

Description of a task an agent has schedule to be performed at a later time. This class is not thread-safe.

Version:

io.sarl.core 0.12.0 20210527-171007

Author:

Sebastian Rodriguez, Stéphane Galland

Maven Group Id:

io.sarl

Maven Artifact Id:

io.sarl.core

Field Summary

Fields

Modifier and Type	Field and Description
static (Agent)=>Boolean	FALSE_GUARD A guard that is always false.
static (Agent)=>Boolean	TRUE_GUARD A guard that is always true.

Constructor Summary

Constructors

Constructor and Description
AgentTask(name : String, [initiator : Object]) Construct an AgentTask with the given initiator.

Method Summary

Modifier and Type	Method and Description
(Agent)=>Boolean	getGuard() Replies the guard of this task.
Object	getInitiator() Replies the object that has initiated the execution of this task.
String	getName() Replies the name of this task.
(Agent)=>void	getProcedure() Replies the procedure that is associated to this task.
AgentTask	ifTrue(predicate : (Agent)=>Boolean) Change the guard to the given predicate.
void	setGuard(guard : (Agent)=>Boolean) Change the guard of this task.
void	setProcedure(procedure : (Agent)=>void) Change the procedure associated to this task.
void	setTaskName(name : String) Change the name of this task.
String	toString()
AgentTask	unless(predicate : (Agent)=>Boolean) Change the guard of this that with the negation of the given predicate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TRUE_GUARD

public static val TRUE_GUARD : (Agent)=>Boolean

Description copied from class: AgentTask

A guard that is always true.

FALSE_GUARD

public static val FALSE_GUARD : (Agent)=>Boolean

Description copied from class: AgentTask

A guard that is always false.

Constructor Detail

AgentTask

public new(name : String,
           [initiator : Object])

Construct an AgentTask with the given initiator.

Parameters:

name - the name of the task.

initiator - the object that has initiated the execution of this task. If the value is null (the default value of the argument), the agent is assumed to be the initiator.

Method Detail

getProcedure

@Pure
public def getProcedure() : (Agent)=>void 

Description copied from class: AgentTask

Replies the procedure that is associated to this task.

Returns:

the procedure to run.

setProcedure

public def setProcedure(procedure : (Agent)=>void) : void 

Description copied from class: AgentTask

Change the procedure associated to this task.

Parameters:

procedure - code of the procedure to associate to the task.

getGuard

@Pure
public def getGuard() : (Agent)=>Boolean 

Description copied from class: AgentTask

Replies the guard of this task.

Returns:

the guard.

setGuard

public def setGuard(guard : (Agent)=>Boolean) : void 

Description copied from class: AgentTask

Change the guard of this task.

Parameters:

guard - the code of the function that is the predicate associated to the guard.

See Also:

AgentTask.unless(org.eclipse.xtext.xbase.lib.Functions.Function1<? super io.sarl.lang.core.Agent, ? extends java.lang.Boolean>), AgentTask.ifTrue(org.eclipse.xtext.xbase.lib.Functions.Function1<? super io.sarl.lang.core.Agent, ? extends java.lang.Boolean>)

getName

@Pure
public def getName() : String 

Description copied from class: AgentTask

Replies the name of this task.

Returns:

the name.

setTaskName

public def setTaskName(name : String) : void 

Description copied from class: AgentTask

Change the name of this task.

Parameters:

name - name of the task.

Since:

0.7, it is part of the private API.

Private API

unless

public def unless(predicate : (Agent)=>Boolean) : AgentTask 

Description copied from class: AgentTask

Change the guard of this that with the negation of the given predicate.

Parameters:

predicate - the code of the function that is the predicate to test.

Returns:

this.

See Also:

AgentTask.setGuard(org.eclipse.xtext.xbase.lib.Functions.Function1<? super io.sarl.lang.core.Agent, ? extends java.lang.Boolean>)

ifTrue

public def ifTrue(predicate : (Agent)=>Boolean) : AgentTask 

Description copied from class: AgentTask

Change the guard to the given predicate.

Parameters:

predicate - the code of the function that is the predicate to test.

Returns:

this.

See Also:

AgentTask.setGuard(org.eclipse.xtext.xbase.lib.Functions.Function1<? super io.sarl.lang.core.Agent, ? extends java.lang.Boolean>)

toString

@Pure
public def toString() : String 

Overrides:

toString in class Object

getInitiator

@Pure
public def getInitiator() : Object 

Description copied from class: AgentTask

Replies the object that has initiated the execution of this task. If the value replied by this function is null, the agent is assumed to be the initiator.

Returns:

the initiator, or null if the initiator is the agent itself.

Since:

0.5