io.sarl.lang.core

Class AgentTrait

java.lang.Object

io.sarl.lang.core.SRESpecificDataContainer

io.sarl.lang.core.AgentProtectedAPIObject

io.sarl.lang.core.AgentTrait

public abstract class AgentTrait
extends AgentProtectedAPIObject

This class represents a part of trait of an agent.

Version:

io.sarl.lang.core 0.12.0 20210527-171007

Author:

Sebastian Rodriguez, Stéphane Galland

Maven Group Id:

io.sarl.lang

Maven Artifact Id:

io.sarl.lang.core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AgentTrait() Construct a trait.
protected	AgentTrait(agent : Agent) Construct a trait to the given agent.

Method Summary

Modifier and Type	Method and Description
protected <S extends Capacity> S	clearSkill(capacity : Class<S>) Clears the Skill associated with the capacity.
UUID	getID() Replies the identifier of the agent that has this trait.
Agent	getOwner() Replies the agent that has this trait.
protected <S extends Capacity> S	getSkill(capacity : Class<S>) Replies the skill corresponding to the given capacity.
protected boolean	hasSkill(capacity : Class<? extends Capacity>) Checks if this agent has a Skill that implements the Capacity capacity.
boolean	isFromMe(event : Event) Replies if the given event was emitted by this agent.
boolean	isMe(address : Address) Replies if the given address is one of the addresses of this agent.
boolean	isMe(uID : UUID) Replies if the given identifier corresponds to the identifier of this agent.
protected <S extends Skill> void	operator_mappedTo(capacity : Class<? extends Capacity>, skill : S) Defines the implementation of the "capacity maps-to skill" operator.
protected <S extends Skill> S	setSkill(skill : S, capacities : Class<? extends Capacity>*) Set the skill for the Capacity capacity.
protected void	setSkillIfAbsent(skill : Skill, capacities : Class<? extends Capacity>*) Set the skill for the Capacity capacity if the mapping is not yet set.
protected void	toString(builder : org.eclipse.xtext.xbase.lib.util.ToStringBuilder) fill the given builder with the string representation of this object.

Methods inherited from class io.sarl.lang.core.AgentProtectedAPIObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentTrait

protected new(agent : Agent)

Construct a trait to the given agent.

Parameters:

agent - the owner of this trait.

AgentTrait

protected new()

Construct a trait.

Method Detail

toString

protected def toString(builder : org.eclipse.xtext.xbase.lib.util.ToStringBuilder) : void 

Description copied from class: AgentProtectedAPIObject

fill the given builder with the string representation of this object.

Specified by:

toString in class AgentProtectedAPIObject

Parameters:

builder - the string builder.

getOwner

@Pure
public def getOwner() : Agent 

Description copied from class: AgentTrait

Replies the agent that has this trait.

Returns:

the owner.

getID

@Pure
public def getID() : UUID 

Description copied from class: AgentTrait

Replies the identifier of the agent that has this trait.

Returns:

the UUID of the owner.

Since:

0.6

getSkill

@Pure
protected final def getSkill(capacity : Class<S>) : S  with <S extends Capacity> 

Description copied from class: AgentProtectedAPIObject

Replies the skill corresponding to the given capacity.

The return may never be null. If not capacity was set, the exception UnimplementedCapacityException is thrown.

Specified by:

getSkill in class AgentProtectedAPIObject

Type Parameters:

S - - type of the capacity.

Parameters:

capacity - the capacity to search for the implementation.

Returns:

the skill, never null

operator_mappedTo

protected def operator_mappedTo(capacity : Class<? extends Capacity>,
                                skill : S) : void  with <S extends Skill> 

Description copied from class: AgentProtectedAPIObject

Defines the implementation of the "capacity maps-to skill" operator.

Specified by:

operator_mappedTo in class AgentProtectedAPIObject

Type Parameters:

S - - type of skill to be mapped to.

Parameters:

capacity - the implemented capacity.

skill - the skill to associate to the capacity.

setSkill

@SafeVarargs
protected final def setSkill(skill : S,
                                          capacities : Class<? extends Capacity>*) : S  with <S extends Skill> 

Description copied from class: AgentProtectedAPIObject

Set the skill for the Capacity capacity.

Specified by:

setSkill in class AgentProtectedAPIObject

Type Parameters:

S - - type of the skill.

Parameters:

skill - implementation of capacity.

capacities - the capacity or the capacities to set.

Returns:

the skill that was set.

See Also:

AgentProtectedAPIObject.setSkillIfAbsent(Skill, Class...)

setSkillIfAbsent

@SafeVarargs
protected final def setSkillIfAbsent(skill : Skill,
                                                  capacities : Class<? extends Capacity>*) : void 

Description copied from class: AgentProtectedAPIObject

Set the skill for the Capacity capacity if the mapping is not yet set.

Specified by:

setSkillIfAbsent in class AgentProtectedAPIObject

Parameters:

skill - implementation of capacity.

capacities - the capacity or the capacities to set.

See Also:

AgentProtectedAPIObject.setSkill(Skill, Class...)

clearSkill

protected def clearSkill(capacity : Class<S>) : S  with <S extends Capacity> 

Description copied from class: AgentProtectedAPIObject

Clears the Skill associated with the capacity.

Specified by:

clearSkill in class AgentProtectedAPIObject

Type Parameters:

S - - the type of the capacity.

Parameters:

capacity - the capacity for which the skill must be cleared.

Returns:

the skill that was removed

hasSkill

@Pure
protected def hasSkill(capacity : Class<? extends Capacity>) : boolean 

Description copied from class: AgentProtectedAPIObject

Checks if this agent has a Skill that implements the Capacity capacity.

Specified by:

hasSkill in class AgentProtectedAPIObject

Parameters:

capacity - capacity to check

Returns:

true if it has a skill associate to this capacity, false otherwise

isMe

@Pure
public def isMe(address : Address) : boolean 

Description copied from class: AgentProtectedAPIObject

Replies if the given address is one of the addresses of this agent. The test is done on the identifier replied by Address.getID().

Specified by:

isMe in class AgentProtectedAPIObject

Parameters:

address - the address to test.

Returns:

true if the given address is one of this agent, otherwise false.

isMe

@Pure
public def isMe(uID : UUID) : boolean 

Description copied from class: AgentProtectedAPIObject

Replies if the given identifier corresponds to the identifier of this agent.

This function is equivalent to:

 id.equals( agent.getID() )
 

Specified by:

isMe in class AgentProtectedAPIObject

Parameters:

uID - the identifier to test.

Returns:

true if the given identifier is the one of this agent, otherwise false.

isFromMe

@Pure
public def isFromMe(event : Event) : boolean 

Description copied from class: AgentProtectedAPIObject

Replies if the given event was emitted by this agent.

Specified by:

isFromMe in class AgentProtectedAPIObject

Parameters:

event - the event to test.

Returns:

true if the given event was emitted by this agent; otherwise false.