Package modelarium.entities.attributes.sets

Class EnvironmentAttributeSet

java.lang.Object

modelarium.entities.attributes.sets.AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

modelarium.entities.attributes.sets.EnvironmentAttributeSet

public final class EnvironmentAttributeSet
extends AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EnvironmentAttribute	get(int index)	Retrieves a publicly accessible attribute by index.
EnvironmentAttribute	get(String attributeName)	Retrieves a publicly accessible attribute by name.
EnvironmentEvent	getEvent(int eventIndex)	Retrieves an event by its index among this set's events.
EnvironmentEvent	getEvent(String eventName)	Retrieves an event by name.
EnvironmentProperty<?>	getProperty(int propertyIndex)	Retrieves a property by its index among this set's properties.
EnvironmentProperty<?>	getProperty(String propertyName)	Retrieves a property by name.
EnvironmentRoutine	getRoutine(int routineIndex)	Retrieves a routine by its index among this set's routines.
EnvironmentRoutine	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

EnvironmentAttributeSet

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

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

Parameters:

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

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

Method Details

get

public EnvironmentAttribute get(int index)

Retrieves a publicly accessible attribute by index.

Overrides:

get in class AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

Parameters:

index - the index of the attribute to retrieve

Returns:

the EnvironmentAttribute at the specified index

get

public EnvironmentAttribute get(String attributeName)

Retrieves a publicly accessible attribute by name.

Overrides:

get in class AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

Parameters:

attributeName - the name of the attribute to retrieve

Returns:

the EnvironmentAttribute with the specified name

getEvent

public EnvironmentEvent getEvent(int eventIndex)

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

Overrides:

getEvent in class AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

Parameters:

eventIndex - the index of the event to retrieve

Returns:

the EnvironmentEvent at the specified index

getEvent

public EnvironmentEvent getEvent(String eventName)

Retrieves an event by name.

Overrides:

getEvent in class AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

Parameters:

eventName - the name of the event to retrieve

Returns:

the EnvironmentEvent with the specified name

getRoutine

public EnvironmentRoutine getRoutine(int routineIndex)

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

Overrides:

getRoutine in class AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

Parameters:

routineIndex - the index of the routine to retrieve

Returns:

the EnvironmentRoutine at the specified index

getRoutine

public EnvironmentRoutine getRoutine(String routineName)

Retrieves a routine by name.

Overrides:

getRoutine in class AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

Parameters:

routineName - the name of the routine to retrieve

Returns:

the EnvironmentRoutine with the specified name

getProperty

public EnvironmentProperty<?> getProperty(int propertyIndex)

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

Overrides:

getProperty in class AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

Parameters:

propertyIndex - the index of the property to retrieve

Returns:

the EnvironmentProperty at the specified index

getProperty

public EnvironmentProperty<?> getProperty(String propertyName)

Retrieves a property by name.

Overrides:

getProperty in class AttributeSet<EnvironmentSimulationContext,EnvironmentContext>

Parameters:

propertyName - the name of the property to retrieve

Returns:

the EnvironmentProperty with the specified name