ILocalStateOfAgent4Engine (SIMILAR API suite 1.0-SNAPSHOT API)

All Superinterfaces:

ILocalState, ILocalStateOfAgent

All Known Implementing Classes:

AbstractLocalStateOfAgent, EmptyLocalStateOfAgent
```
public interface ILocalStateOfAgent4Engine
extends ILocalStateOfAgent
```
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 pragmatic interface of the local state of an agent, including implementation constraints. In practice, the methods defined in this interface are used by the simulation engine. Therefore, simulation designers will only manipulate methods from the ILocalStateOfAgent parent interface.
Author:

Yoann Kubera

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IAgent4Engine`	`getOwner()`	Gets the owner of the local state, i.e. the agent which public (resp. private) local state at a specific level is this object.

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

Methods inherited from interface fr.univ_artois.lgi2a.similar.microkernel.agents.ILocalStateOfAgent
getCategoryOfAgent, isOwnedBy

- Method Detail
  - getOwner
```
IAgent4Engine getOwner()
```
    Gets the owner of the local state, i.e. the agent which public (resp. private) local state at a specific level is this object.
    This method is defined for optimization purposes, since keeping an association between local states and agents within the simulation engine would be too memory consuming.
    
    Returns:
    
    The owner of this state.