Package modelarium.entities

Class Environment

java.lang.Object

modelarium.entities.Entity<EnvironmentSimulationContext,EnvironmentContext,EnvironmentAttributeSet,AttributeSetLog<EnvironmentSimulationContext>>

modelarium.entities.Environment

public final class Environment
extends Entity<EnvironmentSimulationContext,EnvironmentContext,EnvironmentAttributeSet,AttributeSetLog<EnvironmentSimulationContext>>

Class for representing the environment of the model.

This class is an entity that owns EnvironmentAttributeSet instances and uses an EnvironmentSimulationContext for its behaviour and interactions.

Constructor Summary

Constructors

Constructor	Description
Environment(String name, List<EnvironmentAttributeSet> attributeSets)	Constructs a new environment with the specified name and attribute sets.
Environment(List<EnvironmentAttributeSet> attributeSets)	Constructs a new environment with an attribute sets.

Method Summary

Modifier and Type	Method	Description
ReadOnlyEnvironment	getAsImmutable()	Creates and returns an immutable version of this environment.
EnvironmentEvent	getEvent(String attributeSetName, String eventName)	Retrieves an event attribute from one of this environment's attribute sets.
EnvironmentProperty<?>	getProperty(String attributeSetName, String propertyName)	Retrieves a property attribute from one of this environment's attribute sets.
EnvironmentRoutine	getRoutine(String attributeSetName, String routineName)	Retrieves a routine attribute from one of this environment's attribute sets.

Methods inherited from class modelarium.entities.Entity

attributeCount, attributeSetCount, context, getAttributeSet, getAttributeSet, getLog, name, run

Methods inherited from class java.lang.Object

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

Constructor Details

Environment

public Environment(String name,
 List<EnvironmentAttributeSet> attributeSets)

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

Parameters:

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

attributeSets - the attribute sets the environment will own

Environment

public Environment(List<EnvironmentAttributeSet> attributeSets)

Constructs a new environment with an attribute sets.

Parameters:

attributeSets - the attribute sets the environment will own

Method Details

getEvent

public EnvironmentEvent getEvent(String attributeSetName,
 String eventName)

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

Parameters:

attributeSetName - the name of the attribute set containing the event

eventName - the name of the event to retrieve

Returns:

the EnvironmentEvent with the specified name

getRoutine

public EnvironmentRoutine getRoutine(String attributeSetName,
 String routineName)

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

Parameters:

attributeSetName - the name of the attribute set containing the routine

routineName - the name of the routine to retrieve

Returns:

the EnvironmentRoutine with the specified name

getProperty

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

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

Parameters:

attributeSetName - the name of the attribute set containing the property

propertyName - the name of the property to retrieve

Returns:

the EnvironmentProperty with the specified name

getAsImmutable

public ReadOnlyEnvironment getAsImmutable()

Creates and returns an immutable version of this environment.

Specified by:

getAsImmutable in class Entity<EnvironmentSimulationContext,EnvironmentContext,EnvironmentAttributeSet,AttributeSetLog<EnvironmentSimulationContext>>

Returns:

the new ReadOnlyEnvironment instance