Package modelarium.entities.attributes.sets

Class AgentAttributeSet

java.lang.Object

modelarium.entities.attributes.sets.AttributeSet<AgentSimulationContext,AgentContext>

modelarium.entities.attributes.sets.AgentAttributeSet

public final class AgentAttributeSet
extends AttributeSet<AgentSimulationContext,AgentContext>

Class for containing and managing a named group of an agent's attributes.

This class specialises AttributeSet so that retrieved attributes are returned as their agent-flavoured types.

Constructor Summary

Constructors

Constructor	Description
AgentAttributeSet(String name, List<Attribute> attributes)	Constructs a new agent attribute set with the specified owner, name and attributes.

Method Summary

Modifier and Type	Method	Description
AgentAttribute	get(int index)	Retrieves a publicly accessible attribute by index.
AgentAttribute	get(String attributeName)	Retrieves a publicly accessible attribute by name.
AgentEvent	getEvent(int eventIndex)	Retrieves an event by its index among this set's events.
AgentEvent	getEvent(String eventName)	Retrieves an event by name.
AgentProperty<?>	getProperty(int propertyIndex)	Retrieves a property by its index among this set's properties.
AgentProperty<?>	getProperty(String propertyName)	Retrieves a property by name.
AgentRoutine	getRoutine(int routineIndex)	Retrieves a routine by its index among this set's routines.
AgentRoutine	getRoutine(String routineName)	Retrieves a routine by name.

Methods inherited from class modelarium.entities.attributes.sets.AttributeSet

getLog, name, run, size

Methods inherited from class java.lang.Object

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

Constructor Details

AgentAttributeSet

public AgentAttributeSet(String name,
 List<Attribute> attributes)

Constructs a new agent attribute set with the specified owner, name and attributes.

Parameters:

name - the name of the attribute set, used to identify it within its owning agent

attributes - the attributes the set will contain, in the order they will be run

Method Details

get

public AgentAttribute get(int index)

Retrieves a publicly accessible attribute by index.

Overrides:

get in class AttributeSet<AgentSimulationContext,AgentContext>

Parameters:

index - the index of the attribute to retrieve

Returns:

the AgentAttribute at the specified index

get

public AgentAttribute get(String attributeName)

Retrieves a publicly accessible attribute by name.

Overrides:

get in class AttributeSet<AgentSimulationContext,AgentContext>

Parameters:

attributeName - the name of the attribute to retrieve

Returns:

the AgentAttribute with the specified name

getEvent

public AgentEvent getEvent(int eventIndex)

Retrieves an event by its index among this set's events.

Overrides:

getEvent in class AttributeSet<AgentSimulationContext,AgentContext>

Parameters:

eventIndex - the index of the event to retrieve

Returns:

the AgentEvent at the specified index

getEvent

public AgentEvent getEvent(String eventName)

Retrieves an event by name.

Overrides:

getEvent in class AttributeSet<AgentSimulationContext,AgentContext>

Parameters:

eventName - the name of the event to retrieve

Returns:

the AgentEvent with the specified name

getRoutine

public AgentRoutine getRoutine(int routineIndex)

Retrieves a routine by its index among this set's routines.

Overrides:

getRoutine in class AttributeSet<AgentSimulationContext,AgentContext>

Parameters:

routineIndex - the index of the routine to retrieve

Returns:

the AgentRoutine at the specified index

getRoutine

public AgentRoutine getRoutine(String routineName)

Retrieves a routine by name.

Overrides:

getRoutine in class AttributeSet<AgentSimulationContext,AgentContext>

Parameters:

routineName - the name of the routine to retrieve

Returns:

the AgentRoutine with the specified name

getProperty

public AgentProperty<?> getProperty(int propertyIndex)

Retrieves a property by its index among this set's properties.

Overrides:

getProperty in class AttributeSet<AgentSimulationContext,AgentContext>

Parameters:

propertyIndex - the index of the property to retrieve

Returns:

the AgentProperty at the specified index

getProperty

public AgentProperty<?> getProperty(String propertyName)

Retrieves a property by name.

Overrides:

getProperty in class AttributeSet<AgentSimulationContext,AgentContext>

Parameters:

propertyName - the name of the property to retrieve

Returns:

the AgentProperty with the specified name