Package modelarium.entities.contexts

Class EnvironmentSimulationContext

java.lang.Object

modelarium.entities.contexts.SimulationContext

modelarium.entities.contexts.EnvironmentSimulationContext

All Implemented Interfaces:

Context, EntityContext, EnvironmentContext

public final class EnvironmentSimulationContext
extends SimulationContext
implements EnvironmentContext

Class for providing the environment and its attributes with access to relevant simulation resources.

This class is the concrete EnvironmentContext implementation the model creates for the environment, combining the shared behaviour of SimulationContext with environment-specific entity access.

Method Summary

Modifier and Type	Method	Description
ReadOnlyAgent	getAgent(String targetAgentName)	Retrieves an agent by name.
int	getCurrentPopulationSize()	Returns the model's current population size.
ReadOnlyEnvironment	getEnvironment()	Unsupported for the environment's own context.
ReadOnlyAgentSet	getFilteredAgents(Predicate<ReadOnlyAgent> filter)	Retrieves the living-only agents matching a filter.
ReadOnlyAgentSet	getFilteredAgents(Predicate<ReadOnlyAgent> agentFilter, boolean includeDeadAgents)	Returns an agents matching a filter
AttributeBase<EnvironmentSimulationContext>	getThisAttribute()	Returns the attribute currently being run on the owning environment.
EnvironmentAttributeSet	getThisAttributeSet()	Returns the attribute set currently being run on the owning environment.
Environment	getThisEntity()	Returns the environment this context belongs to.
void	killAgent(String agentName)	Kills the agent with the given name.
void	killAgent(ReadOnlyAgent agent)	Kills the agent of the given ReadOnlyAgent instance.
void	killAgents(List<String> agentNames)	Kills all the agents with names in a given List<String> instance.
void	killAgents(ReadOnlyAgentSet agentSet)	Kills all the agents in a given ReadOnlyAgentSet instance.

Methods inherited from class modelarium.entities.contexts.SimulationContext

addAgent, addAgents, addAgents, attribute, attributeSet, config, doesAgentExistInThisCore, entity, getClock, getRandom, localAgentSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface modelarium.entities.contexts.Context

doesAgentExistInThisCore, getClock, getRandom

Methods inherited from interface modelarium.entities.contexts.EntityContext

addAgent, addAgents, addAgents

Method Details

getThisEntity

public Environment getThisEntity()

Returns the environment this context belongs to.

Specified by:

getThisEntity in interface EnvironmentContext

Specified by:

getThisEntity in class SimulationContext

Returns:

the owning Environment instance

getThisAttributeSet

public EnvironmentAttributeSet getThisAttributeSet()

Returns the attribute set currently being run on the owning environment.

Specified by:

getThisAttributeSet in interface EnvironmentContext

Specified by:

getThisAttributeSet in class SimulationContext

Returns:

the current EnvironmentAttributeSet instance

getThisAttribute

public AttributeBase<EnvironmentSimulationContext> getThisAttribute()

Returns the attribute currently being run on the owning environment.

Specified by:

getThisAttribute in interface EnvironmentContext

Specified by:

getThisAttribute in class SimulationContext

Returns:

the current attribute instance

getEnvironment

public ReadOnlyEnvironment getEnvironment()

Unsupported for the environment's own context.

The context requester is already the environment, so getThisEntity() should be used instead.

Overrides:

getEnvironment in class SimulationContext

Returns:

this method never returns normally

getCurrentPopulationSize

public int getCurrentPopulationSize()

Returns the model's current population size.

Specified by:

getCurrentPopulationSize in interface Context

Overrides:

getCurrentPopulationSize in class SimulationContext

Returns:

the current population size as an int

getAgent

public ReadOnlyAgent getAgent(String targetAgentName)

Retrieves an agent by name.

Specified by:

getAgent in interface Context

Overrides:

getAgent in class SimulationContext

Parameters:

targetAgentName - the name of the agent to retrieve

Returns:

a read-only view of the requested agent

getFilteredAgents

public ReadOnlyAgentSet getFilteredAgents(Predicate<ReadOnlyAgent> filter)

Retrieves the living-only agents matching a filter.

Specified by:

getFilteredAgents in interface Context

Overrides:

getFilteredAgents in class SimulationContext

Parameters:

filter - a predicate to apply to each agent

Returns:

a new ReadOnlyAgentSet containing the matching agents

getFilteredAgents

public ReadOnlyAgentSet getFilteredAgents(Predicate<ReadOnlyAgent> agentFilter,
 boolean includeDeadAgents)

Returns an agents matching a filter

Specified by:

getFilteredAgents in interface Context

Overrides:

getFilteredAgents in class SimulationContext

Parameters:

agentFilter - a predicate to apply to each agent

includeDeadAgents - a boolean which determines if dead agents are to be included in the output agent set or not

Returns:

a new ReadOnlyAgentSet containing only matching agents

killAgent

public void killAgent(String agentName)

Kills the agent with the given name.

Specified by:

killAgent in interface Context

Overrides:

killAgent in class SimulationContext

Parameters:

agentName - the agent's name as a string

killAgent

public void killAgent(ReadOnlyAgent agent)

Kills the agent of the given ReadOnlyAgent instance.

Specified by:

killAgent in interface Context

Overrides:

killAgent in class SimulationContext

Parameters:

agent - the immutable agent to kill

killAgents

public void killAgents(List<String> agentNames)

Kills all the agents with names in a given List<String> instance.

Specified by:

killAgents in interface Context

Overrides:

killAgents in class SimulationContext

Parameters:

agentNames - the list of names of agents to kill

killAgents

public void killAgents(ReadOnlyAgentSet agentSet)

Kills all the agents in a given ReadOnlyAgentSet instance.

Specified by:

killAgents in interface Context

Overrides:

killAgents in class SimulationContext

Parameters:

agentSet - the immutable agent set of agents to kill