Package modelarium.entities

Class Agent

java.lang.Object

modelarium.entities.Entity<AgentSimulationContext,AgentContext,AgentAttributeSet,AttributeSetLog<AgentSimulationContext>>

modelarium.entities.Agent

public final class Agent
extends Entity<AgentSimulationContext,AgentContext,AgentAttributeSet,AttributeSetLog<AgentSimulationContext>>

Class for representing an agent in the model.

This class is an entity that owns AgentAttributeSet instances and uses an AgentSimulationContext for its behaviour and interactions.

Constructor Summary

Constructors

Constructor	Description
Agent(String name, List<AgentAttributeSet> attributeSets)	Constructs a new agent with the specified name and attribute sets.

Method Summary

Modifier and Type	Method	Description
ReadOnlyAgent	getAsImmutable()	Creates and returns an immutable version of this agent.
AgentAttributeSet	getAttributeSet(int attributeSetIndex)	Retrieves an attribute set by index.
AgentAttributeSet	getAttributeSet(String attributeSetName)	Retrieves an attribute set by name.
AgentEvent	getEvent(String attributeSetName, String eventName)	Retrieves an event attribute from one of this agent's attribute sets.
AgentProperty<?>	getProperty(String attributeSetName, String propertyName)	Retrieves a property attribute from one of this agent's attribute sets.
AgentRoutine	getRoutine(String attributeSetName, String routineName)	Retrieves a routine attribute from one of this agent's attribute sets.
boolean	isDead()	Returns whether the agent is dead or not.
void	kill()	Sets the agent to the removed state (killed) so that it no longer functions or contributes to the simulation.
void	run()	Runs each of this agent's attribute sets for the current tick unless it is dead.

Methods inherited from class modelarium.entities.Entity

attributeCount, attributeSetCount, context, getLog, name

Methods inherited from class java.lang.Object

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

Constructor Details

Agent

public Agent(String name,
 List<AgentAttributeSet> attributeSets)

Constructs a new agent with the specified name and attribute sets.

Parameters:

name - the name of the agent, used to identify it within the model

attributeSets - the attribute sets the agent will own

Method Details

getAttributeSet

public AgentAttributeSet getAttributeSet(int attributeSetIndex)

Retrieves an attribute set by index.

Overrides:

getAttributeSet in class Entity<AgentSimulationContext,AgentContext,AgentAttributeSet,AttributeSetLog<AgentSimulationContext>>

Parameters:

attributeSetIndex - the index of the attribute set to retrieve

Returns:

the attribute set at the specified index

getAttributeSet

public AgentAttributeSet getAttributeSet(String attributeSetName)

Retrieves an attribute set by name.

Overrides:

getAttributeSet in class Entity<AgentSimulationContext,AgentContext,AgentAttributeSet,AttributeSetLog<AgentSimulationContext>>

Parameters:

attributeSetName - the name of the attribute set to retrieve

Returns:

the attribute set with the specified name

getEvent

public AgentEvent getEvent(String attributeSetName,
 String eventName)

Retrieves an event attribute from one of this agent's attribute sets.

Parameters:

attributeSetName - the name of the attribute set containing the event

eventName - the name of the event to retrieve

Returns:

the AgentEvent with the specified name

getRoutine

public AgentRoutine getRoutine(String attributeSetName,
 String routineName)

Retrieves a routine attribute from one of this agent's attribute sets.

Parameters:

attributeSetName - the name of the attribute set containing the routine

routineName - the name of the routine to retrieve

Returns:

the AgentRoutine with the specified name

getProperty

public AgentProperty<?> getProperty(String attributeSetName,
 String propertyName)

Retrieves a property attribute from one of this agent's attribute sets.

Parameters:

attributeSetName - the name of the attribute set containing the property

propertyName - the name of the property to retrieve

Returns:

the AgentProperty with the specified name

kill

public void kill()

Sets the agent to the removed state (killed) so that it no longer functions or contributes to the simulation.

isDead

public boolean isDead()

Returns whether the agent is dead or not.

Returns:

the boolean value of whether the agent is dead (true) or not (false)

run

public void run()

Runs each of this agent's attribute sets for the current tick unless it is dead.

Overrides:

run in class Entity<AgentSimulationContext,AgentContext,AgentAttributeSet,AttributeSetLog<AgentSimulationContext>>

getAsImmutable

public ReadOnlyAgent getAsImmutable()

Creates and returns an immutable version of this agent.

Specified by:

getAsImmutable in class Entity<AgentSimulationContext,AgentContext,AgentAttributeSet,AttributeSetLog<AgentSimulationContext>>

Returns:

the new ReadOnlyAgent instance