ILocalStateOfAgent (SIMILAR API suite 1.0-SNAPSHOT API)

All Superinterfaces:

ILocalState

All Known Subinterfaces:

ILocalStateOfAgent4Engine

All Known Implementing Classes:

AbstractLocalStateOfAgent, EmptyLocalStateOfAgent
```
public interface ILocalStateOfAgent
extends ILocalState
```
Models either a public or a private local state of an agent.
Correspondence with theory

An instance of this interface models one of the following elements:
- The public local state of an agent: φ⁺_a(t, l) ∈ Φ⁺_a
- The private local state of an agent: φ^-_a(t, l) ∈ Φ^-_a
Usage

This is the ideal interface of the local state of an agent, from the perspective of a simulation designer. Because of implementation constraints, the private and public local states of an agent have instead to implement the ILocalStateOfAgent4Engine interface.
Author:

Yoann Kubera

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AgentCategory`	`getCategoryOfAgent()`	Gets the category of the agent owning this local state.
`boolean`	`isOwnedBy(IAgent agent)`	Checks if an agent is the owner of a local state.

Methods inherited from interface fr.univ_artois.lgi2a.similar.microkernel.ILocalState
getLevel

- Method Detail
  - getCategoryOfAgent
```
AgentCategory getCategoryOfAgent()
```
    Gets the category of the agent owning this local state.
    It returns the category of the agent "a" within the expression φ⁺_a(t, l), φ^-_a(t, l) (public and private local state of an agent).
    
    Returns:
    
    The category of the agent owning this local state.
    
    See Also:
    
    AgentCategory
  - isOwnedBy
```
boolean isOwnedBy(IAgent agent)
```
    Checks if an agent is the owner of a local state.
    
    Parameters:
    
    agent - The agent which ownership is checked.
    
    Returns:
    
    true if an agent is the owner of a local state.