io.sarl.core

Capacity InnerContextAccess

All Superinterfaces:

Capacity

public interface InnerContextAccess
extends Capacity

Provides functions for accessing and managing the internal contexts of an agent.

Nested Class Summary

Nested classes/interfaces inherited from interface io.sarl.lang.core.Capacity

Capacity.ContextAwareCapacityWrapper<C extends Capacity>

Method Summary

Modifier and Type	Method and Description
AgentContext	getInnerContext() Replies the inner context.
EventSpace	getInnerDefaultSpace() Replies the inner context.
int	getMemberAgentCount() Replies the number of agents that are members of the inner context of the calling agent.
ConcurrentSet<UUID>	getMemberAgents() Replies all the member agents in the inner context.
boolean	hasMemberAgent() Replies if the calling agent has other agents as members of its inner context.
boolean	isInInnerDefaultSpace(event : Event) Replies if the given event was emitted in the default space of the inner context.
boolean	isInnerDefaultSpace(space : Space) Replies if the given space is the default space of the inner context.
boolean	isInnerDefaultSpace(spaceID : SpaceID) Replies if the given identifier is the identifier of the default space of the inner context.
boolean	isInnerDefaultSpace(spaceID : UUID) Replies if the given identifier is the identifier of the default space of the inner context.

Method Detail

getInnerContext

@Pure
def getInnerContext() : AgentContext 

Description copied from interface: InnerContextAccess

Replies the inner context.

Returns:

the instance of the internal agent context.

getInnerDefaultSpace

@Pure
def getInnerDefaultSpace() : EventSpace 

Description copied from interface: InnerContextAccess

Replies the inner context.

Returns:

the instanceof the internal agent context.

Since:

0.12

hasMemberAgent

@Pure
def hasMemberAgent() : boolean 

Description copied from interface: InnerContextAccess

Replies if the calling agent has other agents as members of its inner context. A member agent is an agent which is not the calling agent, and is a member of at least one space of the inner context.

Returns:

true if the current agent has other agents as member of its internal context; otherwise false

getMemberAgentCount

@Pure
def getMemberAgentCount() : int 

Description copied from interface: InnerContextAccess

Replies the number of agents that are members of the inner context of the calling agent. A member agent is an agent which is not the calling agent, and is a member of at least one space of the inner context.

The replied number includes the current agent. Indeed, the current agent is member of its internal context with the role of super-holon.

Returns:

the number of members in the internal context of the current agent.

getMemberAgents

@Pure
def getMemberAgents() : ConcurrentSet<UUID> 

Description copied from interface: InnerContextAccess

Replies all the member agents in the inner context. A member agent is an agent which is not the calling agent, and is a member of at least one space of the inner context.

Returns:

the identifiers of the members of the internal context of the current agent.

isInnerDefaultSpace

@Pure
def isInnerDefaultSpace(space : Space) : boolean 

Description copied from interface: InnerContextAccess

Replies if the given space is the default space of the inner context.

Parameters:

space - the space to test.

Returns:

true if the given space is the default space of the inner context. Otherwise false.

Since:

0.2

isInnerDefaultSpace

@Pure
def isInnerDefaultSpace(spaceID : SpaceID) : boolean 

Description copied from interface: InnerContextAccess

Replies if the given identifier is the identifier of the default space of the inner context.

Parameters:

spaceID - the identifier to test.

Returns:

true if the given identifier is the identifier of the default space of the inner context. Otherwise false.

Since:

0.2

isInnerDefaultSpace

@Pure
def isInnerDefaultSpace(spaceID : UUID) : boolean 

Description copied from interface: InnerContextAccess

Replies if the given identifier is the identifier of the default space of the inner context.

Parameters:

spaceID - the identifier to test.

Returns:

true if the given identifier is the identifier of the default space of the inner context. Otherwise false.

Since:

0.2

isInInnerDefaultSpace

@Pure
def isInInnerDefaultSpace(event : Event) : boolean 

Description copied from interface: InnerContextAccess

Replies if the given event was emitted in the default space of the inner context.

Parameters:

event - the event to test.

Returns:

true if the given event was emitted in the default space of the inner context. Otherwise false.

Since:

0.2