Index
All Classes and Interfaces|All Packages|Serialized Form
A
- accumulateAgentAttributeData() - Method in class modelarium.results.Results
-
Accumulates agent data over all ticks.
- accumulateAgentPostEventResults(String, String, List<?>, List<Boolean>) - Method in class modelarium.results.FunctionalResults
- accumulateAgentPostEventResults(String, String, List<?>, List<Boolean>) - Method in class modelarium.results.Results
-
Subclasses must define how to accumulate agent post-event values.
- accumulateAgentPreEventResults(String, String, List<?>, List<Boolean>) - Method in class modelarium.results.FunctionalResults
- accumulateAgentPreEventResults(String, String, List<?>, List<Boolean>) - Method in class modelarium.results.Results
-
Subclasses must define how to accumulate agent pre-event values.
- accumulateAgentPropertyResults(String, String, List<?>, List<?>) - Method in class modelarium.results.FunctionalResults
- accumulateAgentPropertyResults(String, String, List<?>, List<?>) - Method in class modelarium.results.Results
-
Subclasses must define how to accumulate agent property values.
- add(List<Agent>) - Method in class modelarium.agents.AgentSet
-
Adds a list of agents to the set.
- add(List<AttributeSet>) - Method in class modelarium.attributes.AttributeSetCollection
-
Adds multiple attribute sets to the collection.
- add(List<Event>) - Method in class modelarium.attributes.Events
-
Adds a list of events to the collection.
- add(List<Property<?>>) - Method in class modelarium.attributes.Properties
-
Adds a list of properties to the collection.
- add(Agent) - Method in class modelarium.agents.AgentSet
-
Adds an agent to the set.
- add(AgentSet) - Method in class modelarium.agents.AgentSet
-
Adds all agents from another
AgentSetthat do not already exist in this set. - add(AttributeSet) - Method in class modelarium.attributes.AttributeSetCollection
-
Adds a single attribute set to the collection.
- add(Event) - Method in class modelarium.attributes.Events
-
Adds a single event to the collection.
- add(Property<T>) - Method in class modelarium.attributes.Properties
-
Adds a single property to the collection.
- addAgent(Agent) - Method in class modelarium.multithreading.utils.WorkerCache
-
Adds a single agent to the cache.
- addAgentFilter(Predicate<Agent>) - Method in class modelarium.multithreading.utils.WorkerCache
-
Adds a new agent filter to the list of cached filters.
- addAgents(AgentSet) - Method in class modelarium.multithreading.utils.WorkerCache
-
Adds a full set of agents to the cache.
- addAttribute(Attribute) - Method in class modelarium.attributes.Attributes
-
Adds or replaces an attribute in the collection.
- addEnvironment(Environment) - Method in class modelarium.multithreading.utils.WorkerCache
-
Caches a reference to the environment for reuse within a tick.
- addPostEventValue(String, T) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Adds a new post-event value (e.g. trigger status) for the current tick.
- addPostEventValue(String, T) - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
- addPostEventValue(String, T) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- addPreEventValue(String, T) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Adds a new pre-event value (e.g. trigger status) for the current tick.
- addPreEventValue(String, T) - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
- addPreEventValue(String, T) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- addPropertyValue(String, T) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Adds a new property value to the results database for the current tick.
- addPropertyValue(String, T) - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
- addPropertyValue(String, T) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- Agent - Class in modelarium.agents
-
Represents an agent in the agent-based model.
- Agent(String, AttributeSetCollection) - Constructor for class modelarium.agents.Agent
-
Constructs an agent with the given name and attribute set collection.
- AGENT_ACCESS - Enum constant in enum class modelarium.multithreading.requestresponse.RequestType
-
Request to access a specific agent from another thread or core.
- AGENT_ACCESS - Enum constant in enum class modelarium.multithreading.requestresponse.ResponseType
-
Response to a request for accessing a specific agent from another thread.
- AgentAccess(String, ModelSettings, BlockingQueue<Response>, AgentSet, Environment) - Constructor for class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.AgentAccess
- AgentGenerator - Class in modelarium.agents
-
Abstract base class for generating agent populations in a simulation.
- AgentGenerator() - Constructor for class modelarium.agents.AgentGenerator
- AgentResults - Class in modelarium.results
-
A concrete results container for a set of agents.
- AgentResults(AgentSet) - Constructor for class modelarium.results.AgentResults
-
Constructs agent results from a given agent set.
- AgentSet - Class in modelarium.agents
-
A collection class for managing
Agentinstances, with support for: Optional deep copying of agents on insertion Fast lookup by agent name Filtering, duplication, and setup routines Randomised iteration - AgentSet() - Constructor for class modelarium.agents.AgentSet
-
Constructs an empty agent set without deep copying.
- AgentSet(boolean) - Constructor for class modelarium.agents.AgentSet
-
Constructs an empty agent set with optional deep copy behaviour.
- AgentSet(List<Agent>) - Constructor for class modelarium.agents.AgentSet
-
Constructs a new agent set from a list of agents, without deep copying.
- AgentSet(List<Agent>, boolean) - Constructor for class modelarium.agents.AgentSet
-
Constructs a new agent set from a list of agents, with optional deep copying.
- ALL_WORKERS_FINISH_TICK - Enum constant in enum class modelarium.multithreading.requestresponse.RequestType
-
Indicates that a worker has completed its tick and is ready to synchronise with other workers before continuing.
- ALL_WORKERS_FINISH_TICK - Enum constant in enum class modelarium.multithreading.requestresponse.ResponseType
-
Signals that all workers have completed their current tick and may proceed to the next step.
- ALL_WORKERS_UPDATE_COORDINATOR - Enum constant in enum class modelarium.multithreading.requestresponse.RequestType
-
Indicates that a worker has updated the coordinator with its agent state and is waiting for others to do the same.
- ALL_WORKERS_UPDATE_COORDINATOR - Enum constant in enum class modelarium.multithreading.requestresponse.ResponseType
-
Signals that all workers have finished updating the coordinator with their agent data, allowing coordinated state changes to proceed.
- AllWorkersFinishTick(String, ModelSettings, BlockingQueue<Response>, AgentSet, Environment) - Constructor for class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.AllWorkersFinishTick
- AllWorkersUpdateCoordinator(String, ModelSettings, BlockingQueue<Response>, AgentSet, Environment) - Constructor for class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.AllWorkersUpdateCoordinator
- apply(A, B, C, D) - Method in interface utils.QuadFunction
- Attribute - Class in modelarium.attributes
-
Represents a named attribute associated with a model element such as an agent or environment.
- Attribute(String, boolean) - Constructor for class modelarium.attributes.Attribute
-
Constructs an attribute with the given name and recording flag.
- Attributes - Class in modelarium.attributes
-
Abstract base class for managing a collection of
Attributeinstances. - Attributes() - Constructor for class modelarium.attributes.Attributes
- AttributeSet - Class in modelarium.attributes
-
Represents a named collection of attributes, organised into pre-events, properties, and post-events.
- AttributeSet() - Constructor for class modelarium.attributes.AttributeSet
-
Constructs an attribute set with a generated default name and empty components.
- AttributeSet(String) - Constructor for class modelarium.attributes.AttributeSet
-
Constructs an attribute set with a given name and empty event/property collections.
- AttributeSet(String, Events, Properties, Events) - Constructor for class modelarium.attributes.AttributeSet
-
Constructs an attribute set with a given name and specified components.
- AttributeSetCollection - Class in modelarium.attributes
-
Represents a collection of
AttributeSetinstances associated with a single model element (either an agent or the environment). - AttributeSetCollection() - Constructor for class modelarium.attributes.AttributeSetCollection
- AttributeSetCollectionResults - Class in modelarium.attributes.results
-
Holds the result containers for all
AttributeSetinstances associated with a single model element (e.g. an agent or the environment). - AttributeSetCollectionResults() - Constructor for class modelarium.attributes.results.AttributeSetCollectionResults
- AttributeSetResults - Class in modelarium.attributes.results
-
Stores and manages the recorded results for a single
AttributeSet, including properties and events marked for recording. - AttributeSetResults(String, AttributeSet) - Constructor for class modelarium.attributes.results.AttributeSetResults
-
Constructs the results container for a given attribute set.
- AttributeSetResultsDatabase - Class in modelarium.attributes.results.databases
-
Abstract base class representing a database for storing and retrieving simulation results related to attribute sets, including properties and event values.
- AttributeSetResultsDatabase() - Constructor for class modelarium.attributes.results.databases.AttributeSetResultsDatabase
- AttributeSetResultsDatabaseFactory - Class in modelarium.attributes.results.databases
-
Factory class for creating instances of
AttributeSetResultsDatabase.
C
- call() - Method in class modelarium.multithreading.WorkerThread
-
Executes the simulation loop for this worker.
- clear() - Method in class modelarium.agents.AgentSet
-
Clears the agent set entirely.
- clear() - Method in class modelarium.multithreading.utils.WorkerCache
-
Clears the entire cache.
- clearCustomFactory() - Static method in class modelarium.attributes.results.databases.AttributeSetResultsDatabaseFactory
-
Clears any custom factory that was previously set, reverting to default behaviour.
- clearGeneratedForTests() - Static method in class utils.RandomStringGenerator
-
Test helper: clears the uniqueness set.
- connect() - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Opens the database or output stream for writing.
- connect() - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
-
Establishes an SQLite connection and creates the required tables.
- CoordinatorRequestHandler - Class in modelarium.multithreading.requestresponse
-
Abstract base class for handling requests sent to the coordinator thread in a synchronised model.
- CoordinatorRequestHandler(String, ModelSettings, BlockingQueue<Response>, AgentSet, Environment) - Constructor for class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
- CoordinatorRequestHandler.AgentAccess - Class in modelarium.multithreading.requestresponse
-
Provides access to an individual agent by name.
- CoordinatorRequestHandler.AllWorkersFinishTick - Class in modelarium.multithreading.requestresponse
-
Handles synchronisation for when all workers finish a tick.
- CoordinatorRequestHandler.AllWorkersUpdateCoordinator - Class in modelarium.multithreading.requestresponse
-
Handles synchronisation for when all workers have updated the coordinator.
- CoordinatorRequestHandler.EnvironmentAttributesAccess - Class in modelarium.multithreading.requestresponse
-
Provides access to the current environment state.
- CoordinatorRequestHandler.FilteredAgentsAccess - Class in modelarium.multithreading.requestresponse
-
Provides access to a filtered subset of the global agent set.
- CoordinatorRequestHandler.UpdateCoordinatorAgents - Class in modelarium.multithreading.requestresponse
-
Updates the global agent set with new agent states received from workers.
- CoordinatorThread - Class in modelarium.multithreading
-
Coordinator thread responsible for managing synchronised access to shared simulation state between multiple worker threads in a parallel simulation.
- CoordinatorThread(String, ModelSettings, Environment, RequestResponseController) - Constructor for class modelarium.multithreading.CoordinatorThread
-
Constructs the coordinator thread with required references.
- CoordinatorThread(String, ModelSettings, Environment, RequestResponseController, AgentSet) - Constructor for class modelarium.multithreading.CoordinatorThread
-
Constructs the coordinator thread with required references.
- createDatabase() - Static method in class modelarium.attributes.results.databases.AttributeSetResultsDatabaseFactory
-
Creates a new instance of the configured results database.
D
- DeepCopier - Class in utils
-
Utility class providing methods to perform deep copies of objects using either: Java Serialization (forced for Attribute trees and preferred for Serializable objects) Gson-based JSON serialisation (fallback for non-Attribute, non-Serializable types)
- deepCopy() - Method in class modelarium.agents.Agent
- deepCopy() - Method in class modelarium.attributes.AttributeSet
- deepCopy() - Method in class modelarium.attributes.AttributeSetCollection
- deepCopy() - Method in class modelarium.attributes.Event
- deepCopy() - Method in class modelarium.attributes.Events
- deepCopy() - Method in class modelarium.attributes.functional.FunctionalEvent
- deepCopy() - Method in class modelarium.attributes.functional.FunctionalProperty
- deepCopy() - Method in class modelarium.attributes.Properties
- deepCopy() - Method in class modelarium.attributes.Property
- deepCopy() - Method in class modelarium.environments.Environment
- deepCopy() - Method in class modelarium.results.Results
- deepCopy() - Method in interface utils.DeepCopyable
- deepCopy(T, Class<T>) - Static method in class utils.DeepCopier
-
Creates a deep copy of the given object.
- deepCopy(T, Type) - Static method in class utils.DeepCopier
-
Creates a deep copy of the given object using a specified
Type. - DeepCopyable<T> - Interface in utils
- DefaultAgentGenerator - Class in modelarium.agents
-
A basic implementation of
AgentGeneratorthat creates agents with deep-copied base attribute sets and assigns them unique sequential names. - DefaultAgentGenerator() - Constructor for class modelarium.agents.DefaultAgentGenerator
- DefaultEnvironmentGenerator - Class in modelarium.environments
-
Default generator for creating the simulation environment.
- DefaultEnvironmentGenerator() - Constructor for class modelarium.environments.DefaultEnvironmentGenerator
- disconnect() - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Closes the database or output stream.
- disconnect() - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
-
Closes the SQLite connection and deletes the database file.
- disconnectAccumulatedDatabases() - Method in class modelarium.results.Results
-
Disconnects all accumulated/processed databases if connected.
- disconnectAllDatabases() - Method in class modelarium.results.Results
-
Disconnects all raw and processed databases.
- disconnectDatabase() - Method in class modelarium.attributes.results.AttributeSetResults
-
Closes the underlying database and releases any held resources.
- disconnectDatabases() - Method in class modelarium.attributes.results.AttributeSetCollectionResults
-
Closes and clears all result databases associated with this collection.
- disconnectDatabases() - Method in class modelarium.results.ModelElementResults
-
Disconnects all underlying databases associated with stored attribute set results.
- disconnectRawDatabases() - Method in class modelarium.results.Results
-
Disconnects all raw (per-agent and environment) databases if connected.
- DiskBasedAttributeSetResultsDatabase - Class in modelarium.attributes.results.databases
-
Concrete implementation of
AttributeSetResultsDatabasethat stores results in a temporary SQLite database file. - DiskBasedAttributeSetResultsDatabase() - Constructor for class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
-
Registers this instance for automatic disconnect on JVM shutdown
- doesAgentExist(String) - Method in class modelarium.agents.AgentSet
-
Checks if an agent exists in the set by name.
- doesAgentExist(String) - Method in class modelarium.multithreading.utils.WorkerCache
-
Checks if a specific agent exists in the cache.
- doesAgentExistInThisCore(String) - Method in class modelarium.ModelElementAccessor
-
Checks whether an agent with the given name exists in this core/thread.
- doesAgentFilterExist(Predicate<Agent>) - Method in class modelarium.multithreading.utils.WorkerCache
-
Checks whether a specific agent filter has already been applied and cached.
- doesEnvironmentExist() - Method in class modelarium.multithreading.utils.WorkerCache
-
Checks whether an environment instance has already been cached.
- duplicate() - Method in class modelarium.agents.AgentSet
-
Returns a duplicate of this agent set.
E
- Environment - Class in modelarium.environments
-
Represents the simulation environment in the model.
- Environment(String, AttributeSetCollection) - Constructor for class modelarium.environments.Environment
-
Constructs a new environment with the given name and attribute sets.
- ENVIRONMENT_ATTRIBUTES_ACCESS - Enum constant in enum class modelarium.multithreading.requestresponse.RequestType
-
Request to retrieve the current state of the environment's attributes.
- ENVIRONMENT_ATTRIBUTES_ACCESS - Enum constant in enum class modelarium.multithreading.requestresponse.ResponseType
-
Response containing the current state of environment attributes.
- EnvironmentAttributesAccess(String, ModelSettings, BlockingQueue<Response>, AgentSet, Environment) - Constructor for class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.EnvironmentAttributesAccess
- EnvironmentGenerator - Class in modelarium.environments
-
Abstract base class responsible for generating the simulation
Environment. - EnvironmentGenerator() - Constructor for class modelarium.environments.EnvironmentGenerator
- EnvironmentResults - Class in modelarium.results
-
A concrete results container for the simulation environment.
- EnvironmentResults(Environment) - Constructor for class modelarium.results.EnvironmentResults
-
Constructs a results container for the given environment.
- Event - Class in modelarium.attributes
-
Represents a boolean-triggered event that is evaluated each tick.
- Event() - Constructor for class modelarium.attributes.Event
-
Constructs an event with a generated name and recording enabled by default.
- Event(boolean) - Constructor for class modelarium.attributes.Event
-
Constructs an event with a generated name and a recording flag.
- Event(String) - Constructor for class modelarium.attributes.Event
-
Constructs an event with a specified name, defaulting to recording enabled.
- Event(String, boolean) - Constructor for class modelarium.attributes.Event
-
Constructs an event with a specific name and recording flag.
- EventIsTriggeredFunction - Interface in modelarium.attributes.functional
- EventRunFunction - Interface in modelarium.attributes.functional
- Events - Class in modelarium.attributes
-
A concrete collection class for managing
Eventattributes. - Events() - Constructor for class modelarium.attributes.Events
F
- FILTERED_AGENTS_ACCESS - Enum constant in enum class modelarium.multithreading.requestresponse.RequestType
-
Request to access a subset of agents based on a filter predicate.
- FILTERED_AGENTS_ACCESS - Enum constant in enum class modelarium.multithreading.requestresponse.ResponseType
-
Response containing a filtered set of agents based on a predicate.
- FilteredAgentsAccess(String, ModelSettings, BlockingQueue<Response>, AgentSet, Environment) - Constructor for class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.FilteredAgentsAccess
- FunctionalAgentGenerator - Class in modelarium.agents
-
An implementation of
AgentGeneratorthat delegates agent creation logic to a user-defined functional interface. - FunctionalAgentGenerator(Function<ModelSettings, Agent>) - Constructor for class modelarium.agents.FunctionalAgentGenerator
-
Constructs a new generator with the specified logic.
- FunctionalEnvironmentGenerator - Class in modelarium.environments
-
A functional implementation of
EnvironmentGeneratorthat delegates environment creation to a user-provided function. - FunctionalEnvironmentGenerator(Function<ModelSettings, Environment>) - Constructor for class modelarium.environments.FunctionalEnvironmentGenerator
-
Constructs a new functional generator.
- FunctionalEvent - Class in modelarium.attributes.functional
-
An event whose logic is defined via functional interfaces.
- FunctionalEvent(String, boolean, EventRunFunction, EventIsTriggeredFunction) - Constructor for class modelarium.attributes.functional.FunctionalEvent
-
Constructs a functional event with the given name, recording flag, and behaviour.
- FunctionalProperty<T> - Class in modelarium.attributes.functional
-
A property whose behaviour is defined using functional interfaces.
- FunctionalProperty(String, boolean, Class<T>, PropertyGetterFunction<T>, PropertySetterFunction<T>, PropertyRunFunction<T>) - Constructor for class modelarium.attributes.functional.FunctionalProperty
-
Constructs a functional property with the given name, type, recording flag, and logic.
- FunctionalResults - Class in modelarium.results
-
A functional implementation of
Resultsthat allows users to define accumulation logic using functional interfaces. - FunctionalResults(QuadFunction<String, String, List<?>, List<?>, List<?>>, QuadFunction<String, String, List<Boolean>, List<Boolean>, List<?>>, QuadFunction<String, String, List<Boolean>, List<Boolean>, List<?>>) - Constructor for class modelarium.results.FunctionalResults
-
Constructs a new FunctionalResults instance.
- FunctionalScheduler - Class in modelarium.scheduler
-
A scheduler implementation that delegates each simulation tick to a user-defined function.
- FunctionalScheduler(Consumer<AgentSet>) - Constructor for class modelarium.scheduler.FunctionalScheduler
-
Constructs a FunctionalScheduler with the specified tick function.
G
- generateAgent(ModelSettings) - Method in class modelarium.agents.AgentGenerator
-
Abstract method for generating a single agent instance.
- generateAgent(ModelSettings) - Method in class modelarium.agents.DefaultAgentGenerator
-
Generates a single agent with a unique name and a deep copy of the base attribute set.
- generateAgent(ModelSettings) - Method in class modelarium.agents.FunctionalAgentGenerator
- generateAgents(ModelSettings) - Method in class modelarium.agents.AgentGenerator
-
Generates a complete
AgentSetbased on the number of agents specified in the model settings. - generateEnvironment(ModelSettings) - Method in class modelarium.environments.DefaultEnvironmentGenerator
-
Generates the simulation environment using default settings.
- generateEnvironment(ModelSettings) - Method in class modelarium.environments.EnvironmentGenerator
-
Creates and returns a fully initialised
Environmentfor the simulation. - generateEnvironment(ModelSettings) - Method in class modelarium.environments.FunctionalEnvironmentGenerator
- generateRandomString(int) - Static method in class utils.RandomStringGenerator
-
Generates a random alphanumeric string of the specified length.
- generateUniqueRandomString(int) - Static method in class utils.RandomStringGenerator
-
Generates a unique random alphanumeric string of the specified length.
- get() - Method in class modelarium.attributes.functional.FunctionalProperty
- get() - Method in class modelarium.attributes.Property
-
Retrieves the current value of this property.
- get(int) - Method in class modelarium.agents.AgentSet
-
Retrieves an agent by index.
- get(int) - Method in class modelarium.attributes.AttributeSetCollection
-
Retrieves an attribute set by its index.
- get(int) - Method in class modelarium.attributes.Events
-
Retrieves an event by index.
- get(int) - Method in class modelarium.attributes.Properties
-
Retrieves a property by index.
- get(String) - Method in class modelarium.agents.AgentSet
-
Retrieves an agent by name.
- get(String) - Method in class modelarium.attributes.AttributeSetCollection
-
Retrieves an attribute set by name.
- get(String) - Method in class modelarium.attributes.Events
-
Retrieves an event by name.
- get(String) - Method in class modelarium.attributes.Properties
-
Retrieves a property by name.
- get(ModelElement, T) - Method in interface modelarium.attributes.functional.PropertyGetterFunction
- getAccumulatedAgentPostEventValues(String, String) - Method in class modelarium.results.Results
- getAccumulatedAgentPreEventValues(String, String) - Method in class modelarium.results.Results
- getAccumulatedAgentPropertyValues(String, String) - Method in class modelarium.results.Results
- getAccumulatedEnvironmentPostEventValues(String, String) - Method in class modelarium.results.Results
- getAccumulatedEnvironmentPreEventValues(String, String) - Method in class modelarium.results.Results
- getAccumulatedEnvironmentPropertyValues(String, String) - Method in class modelarium.results.Results
- getAgent(String) - Method in class modelarium.multithreading.utils.WorkerCache
-
Retrieves an agent from the cache by name.
- getAgentByName(String) - Method in class modelarium.ModelElementAccessor
-
Retrieves an agent by name, checking local storage first, then cache, then (if enabled) contacting the coordinator.
- getAgentFromCoordinator(String, String) - Method in class modelarium.multithreading.requestresponse.RequestResponseInterface
-
Requests a specific agent from the coordinator.
- getAgentGenerator() - Method in class modelarium.ModelSettings
- getAgentNames() - Method in class modelarium.results.Results
-
Returns a list of all agent names involved in the model.
- getAgentPostEventValues(String, String, String) - Method in class modelarium.results.Results
- getAgentPreEventValues(String, String, String) - Method in class modelarium.results.Results
- getAgentPropertyValues(String, String, String) - Method in class modelarium.results.Results
- getAgentsForEachCore(ModelSettings) - Method in class modelarium.agents.AgentGenerator
-
Distributes agents across processing cores in a round-robin fashion.
- getAreAttributeSetResultsStoredOnDisk() - Method in class modelarium.ModelSettings
- getAreProcessesSynced() - Method in class modelarium.ModelSettings
- getAsList() - Method in class modelarium.agents.AgentSet
-
Returns the list of agents in this set.
- getAssociatedModelElement() - Method in class modelarium.attributes.Attribute
-
Retrieves the model element this attribute is associated with.
- getAssociatedModelElement() - Method in class modelarium.attributes.Attributes
-
Retrieves the model element associated with attributes.
- getAttribute(int) - Method in class modelarium.attributes.Attributes
-
Retrieves an attribute by its index in the list.
- getAttribute(String) - Method in class modelarium.attributes.Attributes
-
Retrieves an attribute by its name.
- getAttributeSetCollection() - Method in class modelarium.ModelElement
- getAttributeSetCollectionResults() - Method in class modelarium.results.EnvironmentResults
-
Returns the full results object for the environment's attribute sets.
- getAttributeSetCollectionResults(int) - Method in class modelarium.results.ModelElementResults
-
Retrieves an
AttributeSetCollectionResultsby its index. - getAttributeSetCollectionResults(String) - Method in class modelarium.results.ModelElementResults
-
Retrieves the
AttributeSetCollectionResultsfor a specific model element. - getAttributeSetCollectionSetCount() - Method in class modelarium.results.ModelElementResults
- getAttributeSetCount() - Method in class modelarium.attributes.results.AttributeSetCollectionResults
- getAttributeSetName() - Method in class modelarium.attributes.results.AttributeSetResults
- getAttributeSetResults(int) - Method in class modelarium.attributes.results.AttributeSetCollectionResults
-
Retrieves the results object by index.
- getAttributeSetResults(String) - Method in class modelarium.attributes.results.AttributeSetCollectionResults
-
Retrieves the results object for a given attribute set name.
- getBaseAgentAttributeSetCollection() - Method in class modelarium.ModelSettings
- getBaseEnvironmentAttributeSetCollection() - Method in class modelarium.ModelSettings
- getDatabasePath() - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
- getDestination() - Method in class modelarium.multithreading.requestresponse.Request
- getDestination() - Method in class modelarium.multithreading.requestresponse.Response
- getDoAgentStoresHoldAgentCopies() - Method in class modelarium.ModelSettings
- getEnvironment() - Method in class modelarium.ModelElementAccessor
-
Retrieves the current environment for the model element.
- getEnvironment() - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
- getEnvironment() - Method in class modelarium.multithreading.utils.WorkerCache
-
Returns the cached environment instance.
- getEnvironmentFromCoordinator(String) - Method in class modelarium.multithreading.requestresponse.RequestResponseInterface
-
Requests the current environment state from the coordinator.
- getEnvironmentGenerator() - Method in class modelarium.ModelSettings
- getEnvironmentPostEventValues(String, String) - Method in class modelarium.results.Results
- getEnvironmentPreEventValues(String, String) - Method in class modelarium.results.Results
- getEnvironmentPropertyValues(String, String) - Method in class modelarium.results.Results
- getFilteredAgents(Predicate<Agent>) - Method in class modelarium.agents.AgentSet
-
Returns a filtered view of the agent set.
- getFilteredAgents(Predicate<Agent>) - Method in class modelarium.ModelElementAccessor
-
Retrieves a set of agents that match the given filter predicate.
- getFilteredAgents(Predicate<Agent>) - Method in class modelarium.multithreading.utils.WorkerCache
-
Retrieves a filtered set of agents using the cached filter.
- getFilteredAgentsFromCoordinator(String, Predicate<Agent>) - Method in class modelarium.multithreading.requestresponse.RequestResponseInterface
-
Requests a filtered subset of agents from the coordinator.
- getGlobalAgentSet() - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
- getInterface(String) - Method in class modelarium.multithreading.requestresponse.RequestResponseController
-
Creates and returns a
RequestResponseInterfacefor a given thread name. - getIsCacheUsed() - Method in class modelarium.ModelSettings
- getModelClock() - Method in class modelarium.ModelElementAccessor
-
Retrieves the associated clock instance.
- getModelElementAccessor() - Method in class modelarium.ModelElement
- getModelElementName() - Method in class modelarium.attributes.AttributeSetCollection
- getModelElementName() - Method in class modelarium.attributes.results.AttributeSetCollectionResults
- getModelElementName() - Method in class modelarium.attributes.results.AttributeSetResults
- getModelScheduler() - Method in class modelarium.ModelSettings
- getName() - Method in class modelarium.attributes.Attribute
- getName() - Method in class modelarium.attributes.AttributeSet
- getName() - Method in class modelarium.ModelElement
- getNumOfAgents() - Method in class modelarium.ModelSettings
- getNumOfCores() - Method in class modelarium.ModelSettings
- getNumOfTicksToRun() - Method in class modelarium.ModelSettings
- getNumOfWarmUpTicks() - Method in class modelarium.ModelSettings
- getPayload() - Method in class modelarium.multithreading.requestresponse.Request
- getPayload() - Method in class modelarium.multithreading.requestresponse.Response
- getPostEventColumnAsList(String) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Retrieves the full column of recorded values for a post-event.
- getPostEventColumnAsList(String) - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
- getPostEventColumnAsList(String) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- getPostEventNamesList() - Method in class modelarium.attributes.results.AttributeSetResults
- getPostEvents() - Method in class modelarium.attributes.AttributeSet
- getPostEventValues(String) - Method in class modelarium.attributes.results.AttributeSetResults
-
Retrieves all recorded trigger states for a post-event.
- getPostEventValues(String, String) - Method in class modelarium.results.EnvironmentResults
-
Retrieves all recorded trigger states of a post-event from the specified attribute set.
- getPostEventValues(String, String, String) - Method in class modelarium.results.ModelElementResults
-
Retrieves the recorded trigger values for a post-event.
- getPreEventColumnAsList(String) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Retrieves the full column of recorded values for a pre-event.
- getPreEventColumnAsList(String) - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
- getPreEventColumnAsList(String) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- getPreEventNamesList() - Method in class modelarium.attributes.results.AttributeSetResults
- getPreEvents() - Method in class modelarium.attributes.AttributeSet
- getPreEventValues(String) - Method in class modelarium.attributes.results.AttributeSetResults
-
Retrieves all recorded trigger states for a pre-event.
- getPreEventValues(String, String) - Method in class modelarium.results.EnvironmentResults
-
Retrieves all recorded trigger states of a pre-event from the specified attribute set.
- getPreEventValues(String, String, String) - Method in class modelarium.results.ModelElementResults
-
Retrieves the recorded trigger values for a pre-event.
- getProperties() - Method in class modelarium.attributes.AttributeSet
- getPropertyClass(String) - Method in class modelarium.attributes.results.AttributeSetResults
-
Returns the recorded value type of a given property.
- getPropertyColumnAsList(String) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Retrieves the full column of recorded values for a property.
- getPropertyColumnAsList(String) - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
- getPropertyColumnAsList(String) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- getPropertyNamesList() - Method in class modelarium.attributes.results.AttributeSetResults
- getPropertyValues(String) - Method in class modelarium.attributes.results.AttributeSetResults
-
Retrieves all recorded values for a property.
- getPropertyValues(String, String) - Method in class modelarium.results.EnvironmentResults
-
Retrieves all recorded values of a given property from the specified attribute set.
- getPropertyValues(String, String, String) - Method in class modelarium.results.ModelElementResults
-
Retrieves the recorded values for a property from a specific attribute set and model element.
- getRandomIterator() - Method in class modelarium.agents.AgentSet
-
Returns a randomised iterator over the agents in this set.
- getRequester() - Method in class modelarium.multithreading.requestresponse.Request
- getRequester() - Method in class modelarium.multithreading.requestresponse.Response
- getRequestQueue() - Method in class modelarium.multithreading.requestresponse.RequestResponseController
-
Returns the shared request queue.
- getRequestType() - Method in class modelarium.multithreading.requestresponse.Request
- getResponseQueue() - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
- getResponseQueue() - Method in class modelarium.multithreading.requestresponse.RequestResponseController
-
Returns the shared response queue.
- getResponseType() - Method in class modelarium.multithreading.requestresponse.Response
- getResults() - Method in class modelarium.attributes.AttributeSetCollection
- getResults() - Method in class modelarium.ModelSettings
- getSettings() - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
- getThreadName() - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
- getTick() - Method in class modelarium.ModelClock
- getTotalNumOfTicks() - Method in class modelarium.ModelSettings
- getType() - Method in class modelarium.attributes.Property
-
Gets the runtime type of this property's value.
- getWorkersWaiting() - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
H
- handleCoordinatorRequest(Request) - Static method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
-
Handles a coordinator request by dispatching it to the appropriate handler.
- handleRequest(Request) - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.AgentAccess
- handleRequest(Request) - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.AllWorkersFinishTick
- handleRequest(Request) - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.AllWorkersUpdateCoordinator
- handleRequest(Request) - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.EnvironmentAttributesAccess
- handleRequest(Request) - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.FilteredAgentsAccess
- handleRequest(Request) - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
-
Handles an incoming request from a worker.
- handleRequest(Request) - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.UpdateCoordinatorAgents
I
- initialise(String, ModelSettings, BlockingQueue<Response>, AgentSet, Environment) - Static method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
-
Initialises the handler map for the coordinator, assigning an instance of each request type's handler.
- InOrderScheduler - Class in modelarium.scheduler
-
A scheduler that executes each agent in the order they appear in the agent set.
- InOrderScheduler() - Constructor for class modelarium.scheduler.InOrderScheduler
- isRecorded() - Method in class modelarium.attributes.Attribute
- isRunning() - Method in class modelarium.ModelClock
- isTriggered() - Method in class modelarium.attributes.Event
-
Indicates whether the event has been triggered during this tick.
- isTriggered() - Method in class modelarium.attributes.functional.FunctionalEvent
- isTriggered(ModelElement) - Method in interface modelarium.attributes.functional.EventIsTriggeredFunction
- isWarmingUp() - Method in class modelarium.ModelClock
- iterator() - Method in class modelarium.agents.AgentSet
-
Standard iterator over the agents in the order they were added.
M
- MemoryBasedAttributeSetResultsDatabase - Class in modelarium.attributes.results.databases
-
An in-memory implementation of
AttributeSetResultsDatabase. - MemoryBasedAttributeSetResultsDatabase() - Constructor for class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- mergeWith(ModelElementResults) - Method in class modelarium.results.ModelElementResults
-
Merges another results object into this one.
- mergeWithBeforeAccumulation(Results) - Method in class modelarium.results.Results
-
Merges agent results from another simulation run prior to accumulation.
- Model - Class in modelarium
-
Main class for executing an agent-based model using multithreaded execution.
- Model(ModelSettings) - Constructor for class modelarium.Model
-
Constructs a new model instance with the specified settings.
- modelarium - package modelarium
-
Modelarium API.
- modelarium.agents - package modelarium.agents
-
Agent abstractions used in Modelarium simulations.
- modelarium.attributes - package modelarium.attributes
-
Attribute abstractions for storing and accessing model state.
- modelarium.attributes.functional - package modelarium.attributes.functional
-
Functional utilities and abstractions for working with attributes.
- modelarium.attributes.results - package modelarium.attributes.results
-
Attribute-focused helpers for recording simulation results.
- modelarium.attributes.results.databases - package modelarium.attributes.results.databases
-
Database-backed storage for attribute-based simulation results.
- modelarium.environments - package modelarium.environments
-
Environment abstractions for Modelarium simulations.
- modelarium.multithreading - package modelarium.multithreading
-
Internal multithreading and parallel execution support.
- modelarium.multithreading.requestresponse - package modelarium.multithreading.requestresponse
- modelarium.multithreading.utils - package modelarium.multithreading.utils
- modelarium.results - package modelarium.results
-
Result recording and retrieval for Modelarium simulations.
- modelarium.scheduler - package modelarium.scheduler
-
Scheduling and execution control for Modelarium simulations.
- ModelClock - Class in modelarium
- ModelClock(int, int) - Constructor for class modelarium.ModelClock
- ModelElement - Class in modelarium
-
Abstract base class for all model elements in the simulation.
- ModelElement(String, AttributeSetCollection) - Constructor for class modelarium.ModelElement
-
Constructs a model element with the given name and attribute set collection.
- ModelElementAccessor - Class in modelarium
-
Provides a model element (either an agent or the environment) with access to relevant simulation resources such as the local environment, other agents, and shared utilities, including communication and caching systems.
- ModelElementAccessor(ModelElement, AgentSet, ModelSettings, WorkerCache, RequestResponseInterface, Environment) - Constructor for class modelarium.ModelElementAccessor
-
Constructs a new accessor for a model element.
- ModelElementAccessorGenerator - Class in modelarium.scheduler
- ModelElementAccessorGenerator() - Constructor for class modelarium.scheduler.ModelElementAccessorGenerator
- ModelElementResults - Class in modelarium.results
-
Container class for storing and accessing results from one or more
ModelElements, including agents and the environment. - ModelElementResults(List<? extends ModelElement>) - Constructor for class modelarium.results.ModelElementResults
-
Constructs a new results container from a list of model elements.
- ModelElementResults(ModelElement) - Constructor for class modelarium.results.ModelElementResults
-
Constructs a new results container for a single model element.
- ModelScheduler - Interface in modelarium.scheduler
-
Interface representing a scheduling policy for running a single tick of the agent-based model.
- ModelSettings - Class in modelarium
-
Encapsulates all configurable settings for a simulation model run.
- ModelSettings() - Constructor for class modelarium.ModelSettings
P
- processEnvironmentAttributeData() - Method in class modelarium.results.Results
-
Processes the environment data across all ticks.
- processEnvironmentPostEventResults(String, String, List<?>) - Method in class modelarium.results.Results
- processEnvironmentPreEventResults(String, String, List<?>) - Method in class modelarium.results.Results
- processEnvironmentPropertyResults(String, String, List<?>) - Method in class modelarium.results.Results
- Properties - Class in modelarium.attributes
-
A concrete collection class for managing
Propertyattributes. - Properties() - Constructor for class modelarium.attributes.Properties
- Property<T> - Class in modelarium.attributes
-
Represents a stateful, typed property attribute.
- Property(boolean, Class<T>) - Constructor for class modelarium.attributes.Property
-
Constructs a property with a generated name, a recording flag, and type.
- Property(Class<T>) - Constructor for class modelarium.attributes.Property
-
Constructs a property with a generated name, recording enabled, and type.
- Property(String, boolean, Class<T>) - Constructor for class modelarium.attributes.Property
-
Constructs a property with a specific name, recording flag, and type.
- Property(String, Class<T>) - Constructor for class modelarium.attributes.Property
-
Constructs a property with a specific name, recording enabled, and type.
- PropertyGetterFunction<T> - Interface in modelarium.attributes.functional
- PropertyRunFunction<T> - Interface in modelarium.attributes.functional
- PropertySetterFunction<T> - Interface in modelarium.attributes.functional
Q
- QuadFunction<A,
B, - Interface in utilsC, D, R>
R
- RandomOrderScheduler - Class in modelarium.scheduler
-
A scheduler that executes agents in a randomised order for each tick.
- RandomOrderScheduler() - Constructor for class modelarium.scheduler.RandomOrderScheduler
- RandomStringGenerator - Class in utils
-
Utility class for generating random alphanumeric strings.
- recordPostEvent(String, boolean) - Method in class modelarium.attributes.results.AttributeSetResults
-
Records a post-event trigger status for this tick.
- recordPreEvent(String, boolean) - Method in class modelarium.attributes.results.AttributeSetResults
-
Records a pre-event trigger status for this tick.
- recordProperty(String, Object) - Method in class modelarium.attributes.results.AttributeSetResults
-
Records a property value to the backing database for this tick.
- Request - Class in modelarium.multithreading.requestresponse
-
Represents a request sent from a worker thread to the coordinator thread in a synchronised, multithreaded simulation.
- Request(String, String, RequestType, Object) - Constructor for class modelarium.multithreading.requestresponse.Request
-
Constructs a new request to be processed by the coordinator.
- RequestResponseController - Class in modelarium.multithreading.requestresponse
-
Central controller for managing the request and response queues used in synchronised, multithreaded agent-based simulations.
- RequestResponseController(ModelSettings) - Constructor for class modelarium.multithreading.requestresponse.RequestResponseController
-
Constructs a new request-response controller for coordinating simulation threads.
- RequestResponseInterface - Class in modelarium.multithreading.requestresponse
-
Provides a per-thread interface for sending requests to and receiving responses from the simulation coordinator in a synchronised agent-based model.
- RequestResponseInterface(String, ModelSettings, RequestResponseController) - Constructor for class modelarium.multithreading.requestresponse.RequestResponseInterface
-
Constructs a new interface bound to the given model element or thread.
- RequestType - Enum Class in modelarium.multithreading.requestresponse
-
Enum representing the different types of requests that can be sent between worker threads and the coordinator thread during synchronised simulation.
- Response - Class in modelarium.multithreading.requestresponse
-
Represents a response from the coordinator thread to a worker thread in a synchronised simulation model.
- Response(String, String, ResponseType, Object) - Constructor for class modelarium.multithreading.requestresponse.Response
-
Constructs a new response.
- ResponseType - Enum Class in modelarium.multithreading.requestresponse
-
Enum representing the different types of responses returned by the coordinator to worker threads during synchronised simulation execution.
- Results - Class in modelarium.results
-
Abstract base class for storing and manipulating simulation results.
- Results() - Constructor for class modelarium.results.Results
- run() - Method in class modelarium.agents.Agent
-
Executes one simulation step for this agent by invoking the `run()` method of its attribute set collection.
- run() - Method in class modelarium.attributes.Attribute
-
Executes the logic associated with this attribute.
- run() - Method in class modelarium.attributes.Attributes
-
Defines how the entire collection of attributes should be processed during a simulation tick.
- run() - Method in class modelarium.attributes.AttributeSetCollection
-
Executes all attribute sets in the collection for a single simulation tick.
- run() - Method in class modelarium.attributes.Event
-
Runs this event's internal logic.
- run() - Method in class modelarium.attributes.Events
-
Executes all triggered events in the collection.
- run() - Method in class modelarium.attributes.functional.FunctionalEvent
- run() - Method in class modelarium.attributes.functional.FunctionalProperty
- run() - Method in class modelarium.attributes.Properties
-
Executes all properties'
run()methods in sequence. - run() - Method in class modelarium.attributes.Property
-
Executes logic for updating or using the property's value.
- run() - Method in class modelarium.environments.Environment
-
Executes all environment attribute sets for the current tick.
- run() - Method in class modelarium.Model
-
Runs the agent-based model according to the configured settings.
- run() - Method in class modelarium.ModelElement
-
Defines the logic to be executed on each simulation tick.
- run() - Method in class modelarium.multithreading.CoordinatorThread
-
Main execution loop for the coordinator thread.
- run(AttributeSetResults) - Method in class modelarium.attributes.AttributeSet
-
Executes all attributes in the prescribed order: Pre-events (conditionally triggered) Properties (always executed) Post-events (conditionally triggered)
- run(ModelElement) - Method in interface modelarium.attributes.functional.EventRunFunction
- run(ModelElement, T) - Method in interface modelarium.attributes.functional.PropertyRunFunction
- runTick(AgentSet) - Method in class modelarium.scheduler.FunctionalScheduler
-
Executes a single simulation tick by delegating to the user-provided function.
- runTick(AgentSet) - Method in class modelarium.scheduler.InOrderScheduler
-
Executes each agent's
run()method in the order they are stored in the agent set. - runTick(AgentSet) - Method in interface modelarium.scheduler.ModelScheduler
-
Executes a single simulation tick for the provided agent set.
- runTick(AgentSet) - Method in class modelarium.scheduler.RandomOrderScheduler
-
Executes each agent's
run()method in a randomised order.
S
- seal() - Method in class modelarium.results.Results
-
Makes this Results instance immutable, preventing further modification.
- set(ModelElement, T, T) - Method in interface modelarium.attributes.functional.PropertySetterFunction
- set(T) - Method in class modelarium.attributes.functional.FunctionalProperty
- set(T) - Method in class modelarium.attributes.Property
-
Updates the value of this property.
- setAgentGenerator(AgentGenerator) - Method in class modelarium.ModelSettings
-
Sets the generator responsible for creating initial agent populations.
- setAgentNames(List<AgentSet>) - Method in class modelarium.results.Results
-
Stores the names of all agents from a list of agent sets.
- setAgentNames(AgentSet) - Method in class modelarium.results.Results
-
Stores the names of all agents in the model.
- setAgentResults(AgentResults) - Method in class modelarium.results.Results
-
Sets the raw agent results and connects the underlying database.
- setAreAttributeSetResultsStoredOnDisk(boolean) - Method in class modelarium.ModelSettings
-
Sets whether attribute set results are stored on disk or in memory.
- setAreProcessesSynced(boolean) - Method in class modelarium.ModelSettings
-
Specifies whether simulation processes are synchronised (e.g., central coordinator).
- setAssociatedModelElement(ModelElement) - Method in class modelarium.attributes.Attribute
-
Associates this attribute with a specific model element.
- setAssociatedModelElement(ModelElement) - Method in class modelarium.attributes.Attributes
-
Associates all contained attributes with the given model element.
- setAssociatedModelElement(ModelElement) - Method in class modelarium.attributes.AttributeSet
-
Associates all contained attributes with the specified model element.
- setAssociatedModelElement(ModelElement) - Method in class modelarium.attributes.AttributeSetCollection
-
Sets the
ModelElementassociated with the collection's attributes. - setBaseAgentAttributeSetCollection(AttributeSetCollection) - Method in class modelarium.ModelSettings
-
Sets the base attribute configuration for all agents.
- setBaseEnvironmentAttributeSetCollection(AttributeSetCollection) - Method in class modelarium.ModelSettings
-
Sets the base attribute configuration for the environment.
- setCustomFactory(Supplier<AttributeSetResultsDatabase>) - Static method in class modelarium.attributes.results.databases.AttributeSetResultsDatabaseFactory
-
Sets a custom factory to be used instead of the default class-based instantiation.
- setDatabaseClass(Class<T>) - Static method in class modelarium.attributes.results.databases.AttributeSetResultsDatabaseFactory
-
Manually sets the class used for creating result databases.
- setDatabasePath(String) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Sets the path to the database used for output (e.g.
- setDatabasePath(String) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
-
Overrides setDatabasePath but ignores the value, as memory-based storage does not require a file path.
- setDatabaseToDiskBased() - Static method in class modelarium.attributes.results.databases.AttributeSetResultsDatabaseFactory
-
Sets the results database to use a disk-based SQLite backend.
- setDatabaseToMemoryBased() - Static method in class modelarium.attributes.results.databases.AttributeSetResultsDatabaseFactory
-
Sets the results database to use an in-memory backend.
- setDoAgentStoresHoldAgentCopies(boolean) - Method in class modelarium.ModelSettings
-
Sets whether agent stores retain copies of agents or references.
- setEnvironmentGenerator(EnvironmentGenerator) - Method in class modelarium.ModelSettings
-
Sets the generator responsible for creating the simulation environment.
- setEnvironmentResults(EnvironmentResults) - Method in class modelarium.results.Results
-
Sets the raw environment results and connects the underlying database.
- setIsCacheUsed(boolean) - Method in class modelarium.ModelSettings
-
Enables or disables use of caching mechanisms within agent stores.
- setIsStoringAgentCopiesFlag(boolean) - Method in class modelarium.agents.AgentSet
-
Updates the internal flag for whether agent copies should be stored.
- setModelClock(ModelClock) - Method in class modelarium.ModelElementAccessor
-
Sets the associated clock instance.
- setModelElementAccessor(ModelElementAccessor) - Method in class modelarium.ModelElement
-
Sets the model element accessor, which provides external access to model context, data, and messaging.
- setModelScheduler(ModelScheduler) - Method in class modelarium.ModelSettings
-
Sets the scheduler used to coordinate agent and environment updates.
- setNumOfAgents(int) - Method in class modelarium.ModelSettings
-
Sets the number of agents to initialise.
- setNumOfCores(int) - Method in class modelarium.ModelSettings
-
Sets the number of processing cores to use for simulation.
- setNumOfTicksToRun(int) - Method in class modelarium.ModelSettings
-
Sets the number of simulation ticks (excluding warm-up).
- setNumOfWarmUpTicks(int) - Method in class modelarium.ModelSettings
-
Sets the number of warm-up ticks before data is collected.
- setPostEventColumn(String, List<Object>) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Replaces or defines the full column of values for a post-event.
- setPostEventColumn(String, List<Object>) - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
- setPostEventColumn(String, List<Object>) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- setPreEventColumn(String, List<Object>) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Replaces or defines the full column of values for a pre-event.
- setPreEventColumn(String, List<Object>) - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
- setPreEventColumn(String, List<Object>) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- setPropertyColumn(String, List<Object>) - Method in class modelarium.attributes.results.databases.AttributeSetResultsDatabase
-
Replaces or defines the entire set of values for a given property.
- setPropertyColumn(String, List<Object>) - Method in class modelarium.attributes.results.databases.DiskBasedAttributeSetResultsDatabase
- setPropertyColumn(String, List<Object>) - Method in class modelarium.attributes.results.databases.MemoryBasedAttributeSetResultsDatabase
- setResults(Results) - Method in class modelarium.ModelSettings
-
Sets the results instance that will be used to store and process simulation data.
- setResultsClass(Class<T>) - Method in class modelarium.ModelSettings
-
Sets the results class that will be used to store and process simulation data.
- setup() - Method in class modelarium.agents.AgentSet
-
Calls
setup()on all agents in the set. - setup() - Method in class modelarium.ModelElement
-
Initialises the attribute set for this element by calling its setup method.
- setup(String) - Method in class modelarium.attributes.AttributeSetCollection
-
Sets up this collection for simulation by assigning a model element name and preparing the results structure for recording.
- setup(String, List<AttributeSet>) - Method in class modelarium.attributes.results.AttributeSetCollectionResults
-
Prepares this result container for a given model element and its attribute sets.
- setWorkersWaiting(List<String>) - Method in class modelarium.multithreading.requestresponse.CoordinatorRequestHandler
-
Replaces the list of waiting workers (typically to reset it)
- shutdown() - Method in class modelarium.multithreading.CoordinatorThread
-
Signals the coordinator thread to stop processing and terminate.
- SHUTDOWN - Enum constant in enum class modelarium.multithreading.requestresponse.RequestType
-
Request to shut the model down.
- size() - Method in class modelarium.agents.AgentSet
-
Returns the number of agents in the set.
- size() - Method in class modelarium.attributes.Attributes
- size() - Method in class modelarium.attributes.AttributeSetCollection
T
- triggerTick() - Method in class modelarium.ModelClock
U
- update(AgentSet) - Method in class modelarium.agents.AgentSet
-
Updates this set with all agents from another set.
- UPDATE_COORDINATOR_AGENTS - Enum constant in enum class modelarium.multithreading.requestresponse.RequestType
-
Request to update the coordinator with the latest agent data from a worker thread.
- updateCoordinatorAgents(AgentSet) - Method in class modelarium.multithreading.requestresponse.RequestResponseInterface
-
Sends an update to the coordinator with the current agent set for this thread.
- UpdateCoordinatorAgents(String, ModelSettings, BlockingQueue<Response>, AgentSet, Environment) - Constructor for class modelarium.multithreading.requestresponse.CoordinatorRequestHandler.UpdateCoordinatorAgents
- utils - package utils
V
- valueOf(String) - Static method in enum class modelarium.multithreading.requestresponse.RequestType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class modelarium.multithreading.requestresponse.ResponseType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class modelarium.multithreading.requestresponse.RequestType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class modelarium.multithreading.requestresponse.ResponseType
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- waitUntilAllWorkersFinishTick() - Method in class modelarium.multithreading.requestresponse.RequestResponseInterface
-
Waits until all workers have completed their current simulation tick.
- waitUntilAllWorkersUpdateCoordinator() - Method in class modelarium.multithreading.requestresponse.RequestResponseInterface
-
Waits until all workers have updated the coordinator with their agent data.
- WorkerCache - Class in modelarium.multithreading.utils
-
Provides local, thread-specific caching for a simulation worker.
- WorkerCache(boolean) - Constructor for class modelarium.multithreading.utils.WorkerCache
-
Constructs a new worker cache.
- WorkerThread<T> - Class in modelarium.multithreading
-
Represents a single worker thread responsible for simulating one subset of agents across the configured number of ticks.
- WorkerThread(String, ModelSettings, RequestResponseController, AgentSet) - Constructor for class modelarium.multithreading.WorkerThread
-
Constructs a new worker thread to simulate a subset of agents.
All Classes and Interfaces|All Packages|Serialized Form