Package modelarium.entities.readonly

Class ReadOnlyAgent

java.lang.Object

modelarium.entities.readonly.ReadOnlyEntity<AgentSimulationContext,AgentContext,AgentAttributeSet,AttributeSetLog<AgentSimulationContext>>

modelarium.entities.readonly.ReadOnlyAgent

public final class ReadOnlyAgent
extends ReadOnlyEntity<AgentSimulationContext,AgentContext,AgentAttributeSet,AttributeSetLog<AgentSimulationContext>>

Class for providing a read-only view of an Agent.

This class wraps a mutable agent so that other model elements can inspect it without being able to modify it.

Constructor Summary

Constructors

Constructor	Description
ReadOnlyAgent(Agent entity)	Constructs a new immutable agent wrapping the specified mutable agent.

Method Summary

Modifier and Type	Method	Description
ReadOnlyAgentAttributeSet	getAttributeSet(int attributeSetIndex)	Retrieves a read-only view of one of the wrapped agent's attribute sets by index.
ReadOnlyAgentAttributeSet	getAttributeSet(String attributeSetName)	Retrieves a read-only view of one of the wrapped agent's attribute sets by name.
ReadOnlyEvent	getEvent(String attributeSetName, String eventName)	Retrieves a read-only view of an event attribute from one of the wrapped agent's attribute sets.
ReadOnlyProperty<?>	getProperty(String attributeSetName, String propertyName)	Retrieves a read-only view of a property attribute from one of the wrapped agent's attribute sets.
ReadOnlyRoutine	getRoutine(String attributeSetName, String routineName)	Retrieves a read-only view of a routine attribute from one of the wrapped agent's attribute sets.
boolean	isDead()	Returns whether the agent is dead or not.

Methods inherited from class modelarium.entities.readonly.ReadOnlyEntity

attributeCount, attributeSetCount, getLog, getMutableEntity, name

Methods inherited from class java.lang.Object

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

Constructor Details

ReadOnlyAgent

public ReadOnlyAgent(Agent entity)

Constructs a new immutable agent wrapping the specified mutable agent.

Parameters:

entity - the mutable agent to provide a read-only view of

Method Details

getAttributeSet

public ReadOnlyAgentAttributeSet getAttributeSet(int attributeSetIndex)

Retrieves a read-only view of one of the wrapped agent's attribute sets by index.

Specified by:

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

Parameters:

attributeSetIndex - the index of the attribute set to retrieve

Returns:

a new ReadOnlyAgentAttributeSet instance wrapping the attribute set at the specified index

getAttributeSet

public ReadOnlyAgentAttributeSet getAttributeSet(String attributeSetName)

Retrieves a read-only view of one of the wrapped agent's attribute sets by name.

Specified by:

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

Parameters:

attributeSetName - the name of the attribute set to retrieve

Returns:

a new ReadOnlyAgentAttributeSet instance wrapping the attribute set with the specified name

getEvent

public ReadOnlyEvent getEvent(String attributeSetName,
 String eventName)

Retrieves a read-only view of an event attribute from one of the wrapped 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 ReadOnlyEvent with the specified name

getRoutine

public ReadOnlyRoutine getRoutine(String attributeSetName,
 String routineName)

Retrieves a read-only view of a routine attribute from one of the wrapped 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 ReadOnlyRoutine with the specified name

getProperty

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

Retrieves a read-only view of a property attribute from one of the wrapped 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 ReadOnlyProperty with the specified name

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)