Index

A B C D E F G H I K L M N P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

accessLevel() - Method in interface modelarium.entities.attributes.Attribute

Returns the access level of this attribute, determining whether other entities may read it.

accessLevel() - Method in class modelarium.entities.attributes.AttributeBase

Returns the access level of this attribute, determining whether other entities may read it.

accessLevel() - Method in class modelarium.entities.attributes.ReadOnlyAttribute

Returns the access level of this attribute, determining whether other entities may read it.

add(List<Agent>) - Method in class modelarium.entities.agentsets.AgentSet

Adds a list of agents to the set.

add(Agent) - Method in class modelarium.entities.agentsets.AgentSet

Adds an agent to the set.

add(AgentSet) - Method in class modelarium.entities.agentsets.AgentSet

Adds all agents from another AgentSet.

addAgent(Agent) - Method in interface modelarium.entities.contexts.Context

Adds an agent to the current core's local agent set, creating the context the agent needs to run.

addAgent(Agent) - Method in interface modelarium.entities.contexts.EntityContext

Adds an agent to the current core's local agent set, creating the context the agent needs to run.

addAgent(Agent) - Method in class modelarium.entities.contexts.SimulationContext

Adds an agent to the current core's local agent set, creating the context the agent needs to run.

addAgents(List<Agent>) - Method in interface modelarium.entities.contexts.Context

Adds each agent in a list to the current core's local agent set, creating the contexts the agents need to run.

addAgents(List<Agent>) - Method in interface modelarium.entities.contexts.EntityContext

Adds each agent in a list to the current core's local agent set, creating the contexts the agents need to run.

addAgents(List<Agent>) - Method in class modelarium.entities.contexts.SimulationContext

Adds each agent in a list to the current core's local agent set, creating the contexts the agents need to run.

addAgents(AgentSet) - Method in interface modelarium.entities.contexts.Context

Adds each agent in an agent set to the current core's local agent set, creating the contexts the agents need to run.

addAgents(AgentSet) - Method in interface modelarium.entities.contexts.EntityContext

Adds each agent in an agent set to the current core's local agent set, creating the contexts the agents need to run.

addAgents(AgentSet) - Method in class modelarium.entities.contexts.SimulationContext

Adds each agent in an agent set to the current core's local agent set, creating the contexts the agents need to run.

addAttributeValue(String, T) - Method in class modelarium.entities.logging.databases.AttributeSetLogDatabase

Appends a value to the named attribute's stored series.

addAttributeValue(String, T) - Method in class modelarium.entities.logging.databases.DiskBasedAttributeSetLogDatabase

Appends a value to the named attribute's stored series, remembering the value's class for later deserialisation.

addAttributeValue(String, T) - Method in class modelarium.entities.logging.databases.MemoryBasedAttributeSetLogDatabase

Appends a value to the named attribute's stored series, checking that it matches the type of the values already stored.

addDeepCopy(List<Agent>) - Method in class modelarium.entities.agentsets.AgentSet

Adds a deep copy of each agent in a list to the set.

addDeepCopy(Agent) - Method in class modelarium.entities.agentsets.AgentSet

Adds a deep copy of an agent to the set.

addDeepCopy(AgentSet) - Method in class modelarium.entities.agentsets.AgentSet

Adds a deep copy of each agent from another AgentSet.

Agent - Class in modelarium.entities

Class for representing an agent in the model.

Agent(String, List<AgentAttributeSet>) - Constructor for class modelarium.entities.Agent

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

AgentAttribute - Interface in modelarium.entities.attributes

Interface for marking an attribute as belonging to an agent.

AgentAttributeSet - Class in modelarium.entities.attributes.sets

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

AgentAttributeSet(String, List<Attribute>) - Constructor for class modelarium.entities.attributes.sets.AgentAttributeSet

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

AgentContext - Interface in modelarium.entities.contexts

Interface for providing an agent's attributes with access to their owning agent and the wider model.

AgentEvent - Class in modelarium.entities.attributes.events

Abstract class for representing an event belonging to an agent.

AgentEvent(String, boolean, AttributeAccessLevel) - Constructor for class modelarium.entities.attributes.events.AgentEvent

Constructs a new agent event with the specified name, logging flag and access level.

AgentEventIsTriggeredFunction - Interface in modelarium.entities.attributes.events.functional

Functional interface for defining the trigger condition of a functional agent event.

AgentEventRunFunction - Interface in modelarium.entities.attributes.events.functional

Functional interface for defining the behaviour of a functional agent event.

agentGenerator() - Method in record class modelarium.Config

Returns the value of the agentGenerator record component.

agentGenerator(AgentGenerator) - Method in class modelarium.Config.ConfigBuilder

Sets the AgentGenerator instance the model will use to generate agents.

AgentGenerator - Class in modelarium.entities.generators

Abstract class for generating the agent population a model will simulate.

AgentGenerator() - Constructor for class modelarium.entities.generators.AgentGenerator

Constructs an agent generator.

AgentIsDeadException - Exception Class in modelarium.exceptions

Exception for indicating that a requested agent is dead.

AgentIsDeadException(String) - Constructor for exception class modelarium.exceptions.AgentIsDeadException

Constructs a new agent is dead exception with the specified detail message.

agentLogCount() - Method in class modelarium.results.readonly.ReadOnlyResultsForAgents

Returns the number of agents with logs in the results.

agentLogs(String) - Method in class modelarium.results.readonly.ReadOnlyResultsForAgents

Retrieves the values logged for every attribute of an agent.

AgentNotFoundException - Exception Class in modelarium.exceptions

Exception for indicating that a requested agent could not be found.

AgentNotFoundException(String) - Constructor for exception class modelarium.exceptions.AgentNotFoundException

Constructs a new agent not found exception with the specified detail message.

AgentNotFoundException(String, Throwable) - Constructor for exception class modelarium.exceptions.AgentNotFoundException

Constructs a new agent not found exception with the specified detail message and cause.

AgentProperty<T> - Class in modelarium.entities.attributes.properties

Abstract class for representing a property belonging to an agent.

AgentProperty(String, boolean, AttributeAccessLevel, Class<T>) - Constructor for class modelarium.entities.attributes.properties.AgentProperty

Constructs a new agent property with the specified name, logging flag, access level and value type.

AgentPropertyGetterFunction<T> - Interface in modelarium.entities.attributes.properties.functional

Functional interface for defining the getter logic of a functional agent property.

AgentPropertyRunFunction<T> - Interface in modelarium.entities.attributes.properties.functional

Functional interface for defining the behaviour of a functional agent property.

AgentPropertySetterFunction<T> - Interface in modelarium.entities.attributes.properties.functional

Functional interface for defining the setter logic of a functional agent property.

AgentRoutine - Class in modelarium.entities.attributes.routines

Abstract class for representing a routine belonging to an agent.

AgentRoutine(String, AttributeAccessLevel) - Constructor for class modelarium.entities.attributes.routines.AgentRoutine

Constructs a new agent routine with the specified name and access level.

AgentRoutineRunFunction - Interface in modelarium.entities.attributes.routines.functional

Functional interface for defining the behaviour of a functional agent routine.

agents() - Method in class modelarium.results.readonly.ReadOnlyResults

Returns the agent-level results of the model run.

AgentSet - Class in modelarium.entities.agentsets

A collection class for managing Agent instances, 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.entities.agentsets.AgentSet

Constructs an empty agent set without deep copying.

AgentSet(List<Agent>) - Constructor for class modelarium.entities.agentsets.AgentSet

Constructs a new agent set from a list of agents, without deep copying.

AgentSimulationContext - Class in modelarium.entities.contexts

Class for providing an agent and its attributes with access to relevant simulation resources.

allLogs() - Method in class modelarium.results.readonly.ReadOnlyResultsForAgents

Retrieves the values logged for every attribute of every agent in the model.

API status - Search tag in Overview

Section

apply(A, B, C, D) - Method in interface modelarium.utils.QuadFunction

Applies this function to the given arguments.

areThreadsSynced() - Method in record class modelarium.Config

Returns the value of the areThreadsSynced record component.

areThreadsSynced(boolean) - Method in class modelarium.Config.ConfigBuilder

Sets whether the model's threads are synchronised or not.

attribute() - Method in class modelarium.entities.contexts.SimulationContext

Returns the attribute currently being run on the owning entity.

Attribute - Interface in modelarium.entities.attributes

Interface for representing a single named behaviour or value belonging to an entity.

AttributeAccessException - Exception Class in modelarium.exceptions

Exception for indicating that an attribute was accessed in a way that is not permitted.

AttributeAccessException(String) - Constructor for exception class modelarium.exceptions.AttributeAccessException

Constructs a new attribute access exception with the specified detail message.

AttributeAccessLevel - Enum Class in modelarium.entities.attributes

Enum representing the access levels an attribute can have, determining whether other entities may read it.

AttributeBase<C> - Class in modelarium.entities.attributes

Abstract class for providing the shared state and behaviour of all attribute types.

AttributeBase(String, boolean, AttributeAccessLevel) - Constructor for class modelarium.entities.attributes.AttributeBase

Constructs a new attribute with the specified name, logging flag and access level.

attributeCount() - Method in class modelarium.entities.Entity

Returns the total number of attributes across all of this entity's attribute sets.

attributeCount() - Method in class modelarium.entities.readonly.ReadOnlyEntity

Returns the total number of attributes across all of the wrapped entity's attribute sets.

attributeLogCount() - Method in class modelarium.entities.logging.AttributeSetLog

Returns the number of attributes registered for logging.

attributeLogCount(String) - Method in class modelarium.results.readonly.ReadOnlyResultsForEnvironment

Returns the number of attribute logs recorded in the environment's named attribute set.

attributeLogCount(String, String) - Method in class modelarium.results.readonly.ReadOnlyResultsForAgents

Returns the number of attribute logs recorded in the named agent's named attribute set.

attributeLogEntryCount() - Method in class modelarium.entities.logging.AttributeSetLog

Returns the number of entries logged for an attribute so far.

attributeLogs(String, String) - Method in class modelarium.results.readonly.ReadOnlyResultsForEnvironment

Retrieves the values logged for a single attribute of the environment.

attributeLogs(String, String, Class<T>) - Method in class modelarium.results.readonly.ReadOnlyResultsForEnvironment

Retrieves the values logged for a single attribute of the environment, cast to the given type.

attributeLogs(String, String, String) - Method in class modelarium.results.readonly.ReadOnlyResultsForAgents

Retrieves the values logged for a single attribute of an agent.

attributeLogs(String, String, String, Class<T>) - Method in class modelarium.results.readonly.ReadOnlyResultsForAgents

Retrieves the values logged for a single attribute of an agent, cast to the given type.

attributeSet() - Method in class modelarium.entities.contexts.SimulationContext

Returns the attribute set currently being run on the owning entity.

AttributeSet<SC,C> - Class in modelarium.entities.attributes.sets

Abstract class for containing and managing a named group of an entity's attributes.

AttributeSet(String, List<Attribute>) - Constructor for class modelarium.entities.attributes.sets.AttributeSet

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

attributeSetCount() - Method in class modelarium.entities.Entity

Returns the number of attribute sets this entity owns.

attributeSetCount() - Method in class modelarium.entities.readonly.ReadOnlyEntity

Returns the number of attribute sets the wrapped entity owns.

AttributeSetLog<C> - Class in modelarium.entities.logging

Stores and manages the logged results for a single AttributeSet, including properties and events marked for logging.

AttributeSetLog(String, String, AttributeSetLogDatabaseFactory, List<AttributeBase<C>>) - Constructor for class modelarium.entities.logging.AttributeSetLog

Constructs a new attribute set log, creating and connecting its backing database and registering the attributes marked for logging.

attributeSetLogCount() - Method in class modelarium.entities.logging.EntityLog

Returns the number of attribute set logs this entity log collects.

attributeSetLogCount() - Method in class modelarium.results.readonly.ReadOnlyResultsForEnvironment

Returns the number of attribute set logs recorded for the environment.

attributeSetLogCount(String) - Method in class modelarium.results.readonly.ReadOnlyResultsForAgents

Returns the number of attribute set logs recorded for the named agent.

AttributeSetLogDatabase - Class in modelarium.entities.logging.databases

Abstract base class representing a database for storing and retrieving simulation results related to attribute sets, including properties and event values.

AttributeSetLogDatabase() - Constructor for class modelarium.entities.logging.databases.AttributeSetLogDatabase

Constructs a new attribute set log database with no backing file.

AttributeSetLogDatabase(String) - Constructor for class modelarium.entities.logging.databases.AttributeSetLogDatabase

Constructs a new attribute set log database backed by a file at the specified path.

AttributeSetLogDatabaseFactory - Interface in modelarium.entities.logging.databases.factories

Interface for creating the database an attribute set log uses to store its results.

attributeSetLogs(String) - Method in class modelarium.results.readonly.ReadOnlyResultsForEnvironment

Retrieves the values logged for every attribute in one of the environment's attribute sets.

attributeSetLogs(String, String) - Method in class modelarium.results.readonly.ReadOnlyResultsForAgents

Retrieves the values logged for every attribute in one of an agent's attribute sets.

B

build() - Method in class modelarium.Config.ConfigBuilder

Creates a new instance of Config based on the configuration settings provided using the other methods.

builder() - Static method in record class modelarium.Config

Creates a new instance of Config.ConfigBuilder that can assist in the construction of a Config record.

C

call() - Method in class modelarium.multithreading.WorkerThread

Executes the simulation loop for this worker.

clear() - Method in class modelarium.entities.agentsets.AgentSet

Clears the agent set entirely.

Concurrency - Search tag in Overview

Section

config() - Method in class modelarium.entities.contexts.SimulationContext

Returns the model's configuration settings.

Config - Record Class in modelarium

Record for containing the configuration settings of a model.

Config(int, int, int, Duration, boolean, AgentGenerator, EnvironmentGenerator, Scheduler, AttributeSetLogDatabaseFactory, long) - Constructor for record class modelarium.Config

Validates the invariants shared by direct construction and Config.ConfigBuilder construction.

Config.ConfigBuilder - Class in modelarium

Class for assisting in the constructing of a Config record.

ConfigBuilder() - Constructor for class modelarium.Config.ConfigBuilder

Constructs a builder initialised with Modelarium's default configuration values.

connect() - Method in class modelarium.entities.logging.databases.AttributeSetLogDatabase

Opens the database ready for reading and writing.

connect() - Method in class modelarium.entities.logging.databases.DiskBasedAttributeSetLogDatabase

Establishes an SQLite connection and creates the required table.

connect() - Method in class modelarium.entities.logging.databases.MemoryBasedAttributeSetLogDatabase

Opens this database for reading and writing.

context() - Method in class modelarium.entities.attributes.AttributeBase

Returns the context this attribute uses to interact with the rest of the model.

context() - Method in class modelarium.entities.Entity

Returns the simulation context this entity uses.

Context - Interface in modelarium.entities.contexts

Interface for providing model elements with access to shared simulation resources.

coordinator() - Method in record class modelarium.multithreading.CoordinatorHandle

Returns the value of the coordinator record component.

CoordinatorErrorException - Exception Class in modelarium.exceptions

Exception for indicating that the co-ordinator reported an error while handling a request.

CoordinatorErrorException(String, Throwable) - Constructor for exception class modelarium.exceptions.CoordinatorErrorException

Constructs a new coordinator error exception with the specified detail message and cause.

CoordinatorHandle - Record Class in modelarium.multithreading

Record for containing the co-ordinator thread and the runnable it executes.

CoordinatorHandle(Thread, CoordinatorThread) - Constructor for record class modelarium.multithreading.CoordinatorHandle

Creates an instance of a CoordinatorHandle record class.

coordinatorThread() - Method in record class modelarium.multithreading.CoordinatorHandle

Returns the value of the coordinatorThread record component.

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, Config, Environment, RequestResponseController, Clock) - Constructor for class modelarium.multithreading.CoordinatorThread

Constructs the coordinator thread with required references.

CoordinatorThread(String, Config, Environment, RequestResponseController, Clock, AgentSet, Map<String, String>) - Constructor for class modelarium.multithreading.CoordinatorThread

Constructs the coordinator thread with required references.

CoordinatorTimeoutException - Exception Class in modelarium.exceptions

Exception for indicating that a thread timed out while waiting for a response from the co-ordinator.

CoordinatorTimeoutException(String) - Constructor for exception class modelarium.exceptions.CoordinatorTimeoutException

Constructs a new coordinator timeout exception with the specified detail message.

create() - Method in interface modelarium.entities.logging.databases.factories.AttributeSetLogDatabaseFactory

Creates a new attribute set log database.

create() - Method in class modelarium.entities.logging.databases.factories.DiskBasedAttributeSetLogDatabaseFactory

Creates a new disk-based attribute set log database.

create() - Method in class modelarium.entities.logging.databases.factories.MemoryBasedAttributeSetLogDatabaseFactory

Creates a new memory-based attribute set log database.

currentTick() - Method in class modelarium.clock.ReadOnlyClock

Returns the tick the model is currently performing.

D

DefaultAgentGenerator - Class in modelarium.entities.generators

Abstract base class for generating agent populations in a simulation.

DefaultAgentGenerator() - Constructor for class modelarium.entities.generators.DefaultAgentGenerator

Constructs a default agent generator.

disconnect() - Method in class modelarium.entities.logging.databases.AttributeSetLogDatabase

Closes the database, discards all stored data and releases any held resources.

disconnect() - Method in class modelarium.entities.logging.databases.DiskBasedAttributeSetLogDatabase

Closes the SQLite connection and deletes the database file.

disconnect() - Method in class modelarium.entities.logging.databases.MemoryBasedAttributeSetLogDatabase

Clears all stored series and recorded value types.

disconnectDatabase() - Method in class modelarium.entities.logging.AttributeSetLog

Closes the underlying database and releases any held resources.

disconnectDatabases() - Method in class modelarium.entities.logging.EntityLog

Disconnects the database of every collected attribute set log and clears the log collection.

DiskBasedAttributeSetLogDatabase - Class in modelarium.entities.logging.databases

Concrete implementation of AttributeSetLogDatabase that stores results in an SQLite database file.

DiskBasedAttributeSetLogDatabase() - Constructor for class modelarium.entities.logging.databases.DiskBasedAttributeSetLogDatabase

Constructs a new disk-based attribute set log database backed by a file in the system's temporary directory.

DiskBasedAttributeSetLogDatabaseFactory - Class in modelarium.entities.logging.databases.factories

Class for creating disk-based attribute set log databases.

DiskBasedAttributeSetLogDatabaseFactory() - Constructor for class modelarium.entities.logging.databases.factories.DiskBasedAttributeSetLogDatabaseFactory

Constructs a factory for disk-backed attribute-set log databases.

doesAgentExist(String) - Method in class modelarium.entities.agentsets.AgentSet

Checks if an agent exists in the set by name.

doesAgentExist(String) - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Checks if an agent exists in the set by name.

doesAgentExistInThisCore(String) - Method in interface modelarium.entities.contexts.Context

Returns whether an agent with the given name exists on the current core.

doesAgentExistInThisCore(String) - Method in class modelarium.entities.contexts.SimulationContext

Returns whether an agent with the given name exists on the current core.

duplicate() - Method in class modelarium.entities.agentsets.AgentSet

Returns a duplicate of this agent set.

E

entity() - Method in class modelarium.entities.contexts.SimulationContext

Returns the entity this context belongs to.

Entity<SC,C,AS,ASL> - Class in modelarium.entities

Abstract class for representing an element of the model that owns attribute sets and can be run each tick.

Entity(String, List<AS>) - Constructor for class modelarium.entities.Entity

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

EntityContext - Interface in modelarium.entities.contexts

Interface for marking a context as belonging to an entity.

EntityLog<SC,C,AS,ASL> - Class in modelarium.entities.logging

Class for collecting the attribute set logs of a single entity.

EntityLog(String, List<AS>) - Constructor for class modelarium.entities.logging.EntityLog

Constructs a new entity log collecting the logs of the specified attribute sets.

environment() - Method in class modelarium.results.readonly.ReadOnlyResults

Returns the environment-level results of the model run.

Environment - Class in modelarium.entities

Class for representing the environment of the model.

Environment(String, List<EnvironmentAttributeSet>) - Constructor for class modelarium.entities.Environment

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

Environment(List<EnvironmentAttributeSet>) - Constructor for class modelarium.entities.Environment

Constructs a new environment with an attribute sets.

EnvironmentAttribute - Interface in modelarium.entities.attributes

Interface for marking an attribute as belonging to the environment.

EnvironmentAttributeSet - Class in modelarium.entities.attributes.sets

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

EnvironmentAttributeSet(String, List<Attribute>) - Constructor for class modelarium.entities.attributes.sets.EnvironmentAttributeSet

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

EnvironmentContext - Interface in modelarium.entities.contexts

Interface for providing the environment's attributes with access to their owning environment and the wider model.

EnvironmentEvent - Class in modelarium.entities.attributes.events

Abstract class for representing an event belonging to the environment.

EnvironmentEvent(String, boolean, AttributeAccessLevel) - Constructor for class modelarium.entities.attributes.events.EnvironmentEvent

Constructs a new environment event with the specified name, logging flag and access level.

EnvironmentEventIsTriggeredFunction - Interface in modelarium.entities.attributes.events.functional

Functional interface for defining the trigger condition of a functional environment event.

EnvironmentEventRunFunction - Interface in modelarium.entities.attributes.events.functional

Functional interface for defining the behaviour of a functional environment event.

environmentGenerator() - Method in record class modelarium.Config

Returns the value of the environmentGenerator record component.

environmentGenerator(EnvironmentGenerator) - Method in class modelarium.Config.ConfigBuilder

Sets the EnvironmentGenerator instance the model will use to generate the environment.

EnvironmentGenerator - Class in modelarium.entities.generators

Abstract base class responsible for generating the simulation Environment.

EnvironmentGenerator() - Constructor for class modelarium.entities.generators.EnvironmentGenerator

Constructs an environment generator.

environmentLogs() - Method in class modelarium.results.readonly.ReadOnlyResultsForEnvironment

Retrieves the values logged for every attribute of the environment.

EnvironmentNotFoundException - Exception Class in modelarium.exceptions

Exception for indicating that the model's environment could not be retrieved.

EnvironmentNotFoundException(String, Throwable) - Constructor for exception class modelarium.exceptions.EnvironmentNotFoundException

Constructs a new environment not found exception with the specified detail message and cause.

EnvironmentProperty<T> - Class in modelarium.entities.attributes.properties

Abstract class for representing a property belonging to the environment.

EnvironmentProperty(String, boolean, AttributeAccessLevel, Class<T>) - Constructor for class modelarium.entities.attributes.properties.EnvironmentProperty

Constructs a new environment property with the specified name, logging flag, access level and value type.

EnvironmentPropertyGetterFunction<T> - Interface in modelarium.entities.attributes.properties.functional

Functional interface for defining the getter logic of a functional environment property.

EnvironmentPropertyRunFunction<T> - Interface in modelarium.entities.attributes.properties.functional

Functional interface for defining the behaviour of a functional environment property.

EnvironmentPropertySetterFunction<T> - Interface in modelarium.entities.attributes.properties.functional

Functional interface for defining the setter logic of a functional environment property.

EnvironmentRoutine - Class in modelarium.entities.attributes.routines

Abstract class for representing a routine belonging to the environment.

EnvironmentRoutine(String, AttributeAccessLevel) - Constructor for class modelarium.entities.attributes.routines.EnvironmentRoutine

Constructs a new environment routine with the specified name and access level.

EnvironmentRoutineRunFunction - Interface in modelarium.entities.attributes.routines.functional

Functional interface for defining the behaviour of a functional environment routine.

EnvironmentSimulationContext - Class in modelarium.entities.contexts

Class for providing the environment and its attributes with access to relevant simulation resources.

equals(Object) - Method in record class modelarium.Config

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class modelarium.multithreading.CoordinatorHandle

Indicates whether some other object is "equal to" this one.

Event<C> - Class in modelarium.entities.attributes.events

Abstract class for representing an attribute whose behaviour only runs when a trigger condition is met.

export(String) - Method in class modelarium.results.readonly.ReadOnlyResults

Exports the results of the model to a given export directory

export(Path) - Method in class modelarium.results.readonly.ReadOnlyResults

Exports the results of the model to a given export directory given as a Path

F

FunctionalAgentEvent - Class in modelarium.entities.attributes.events.functional

Class for representing an agent event whose logic is defined via functional interfaces.

FunctionalAgentEvent(String, boolean, AttributeAccessLevel, AgentEventRunFunction, AgentEventIsTriggeredFunction) - Constructor for class modelarium.entities.attributes.events.functional.FunctionalAgentEvent

Constructs a new functional agent event with the specified logic functions.

FunctionalAgentGenerator - Class in modelarium.entities.generators

Class for generating agents by delegating creation logic to a user-defined function.

FunctionalAgentGenerator(BiFunction<Config, RandomGenerator, List<AgentSet>>) - Constructor for class modelarium.entities.generators.FunctionalAgentGenerator

Constructs a new generator with the specified logic and uses the default reset logic.

FunctionalAgentGenerator(BiFunction<Config, RandomGenerator, List<AgentSet>>, Runnable) - Constructor for class modelarium.entities.generators.FunctionalAgentGenerator

Constructs a new generator with the specified logic.

FunctionalAgentProperty<T> - Class in modelarium.entities.attributes.properties.functional

Class for representing an agent property whose behaviour is defined via functional interfaces.

FunctionalAgentProperty(String, boolean, AttributeAccessLevel, Class<T>, AgentPropertyGetterFunction<T>, AgentPropertySetterFunction<T>, AgentPropertyRunFunction<T>) - Constructor for class modelarium.entities.attributes.properties.functional.FunctionalAgentProperty

Constructs a new functional agent property with the specified logic functions.

FunctionalAgentRoutine - Class in modelarium.entities.attributes.routines.functional

Class for representing an agent routine whose behaviour is defined via a functional interface.

FunctionalAgentRoutine(String, AttributeAccessLevel, AgentRoutineRunFunction) - Constructor for class modelarium.entities.attributes.routines.functional.FunctionalAgentRoutine

Constructs a new functional agent routine with the specified behaviour function.

FunctionalDefaultAgentGenerator - Class in modelarium.entities.generators

Class for generating agents (via a default generator) by delegating creation logic to a user-defined function.

FunctionalDefaultAgentGenerator(BiFunction<Config, RandomGenerator, Agent>) - Constructor for class modelarium.entities.generators.FunctionalDefaultAgentGenerator

Constructs a new generator with the specified logic.

FunctionalEnvironmentEvent - Class in modelarium.entities.attributes.events.functional

Class for representing an environment event whose logic is defined via functional interfaces.

FunctionalEnvironmentEvent(String, boolean, AttributeAccessLevel, EnvironmentEventRunFunction, EnvironmentEventIsTriggeredFunction) - Constructor for class modelarium.entities.attributes.events.functional.FunctionalEnvironmentEvent

Constructs a new functional environment event with the specified logic functions.

FunctionalEnvironmentGenerator - Class in modelarium.entities.generators

Class for generating the environment by delegating creation logic to a user-provided function.

FunctionalEnvironmentGenerator(BiFunction<Config, RandomGenerator, Environment>) - Constructor for class modelarium.entities.generators.FunctionalEnvironmentGenerator

Constructs a new functional generator and uses the default reset logic.

FunctionalEnvironmentGenerator(BiFunction<Config, RandomGenerator, Environment>, Runnable) - Constructor for class modelarium.entities.generators.FunctionalEnvironmentGenerator

Constructs a new functional generator.

FunctionalEnvironmentProperty<T> - Class in modelarium.entities.attributes.properties.functional

Class for representing an environment property whose behaviour is defined via functional interfaces.

FunctionalEnvironmentProperty(String, boolean, AttributeAccessLevel, Class<T>, EnvironmentPropertyGetterFunction<T>, EnvironmentPropertySetterFunction<T>, EnvironmentPropertyRunFunction<T>) - Constructor for class modelarium.entities.attributes.properties.functional.FunctionalEnvironmentProperty

Constructs a new functional environment property with the specified logic functions.

FunctionalEnvironmentRoutine - Class in modelarium.entities.attributes.routines.functional

Class for representing an environment routine whose behaviour is defined via a functional interface.

FunctionalEnvironmentRoutine(String, AttributeAccessLevel, EnvironmentRoutineRunFunction) - Constructor for class modelarium.entities.attributes.routines.functional.FunctionalEnvironmentRoutine

Constructs a new functional environment routine with the specified behaviour function.

FunctionalScheduler - Class in modelarium.scheduler.functional

Class for scheduling agents using a user-defined function to run each simulation tick.

FunctionalScheduler(TickFunction) - Constructor for class modelarium.scheduler.functional.FunctionalScheduler

Constructs a new functional scheduler with the specified tick function.

G

generateAgent(Config, RandomGenerator) - Method in class modelarium.entities.generators.DefaultAgentGenerator

Abstract method for generating a single agent instance.

generateAgent(Config, RandomGenerator) - Method in class modelarium.entities.generators.FunctionalDefaultAgentGenerator

Generates a single agent by applying the user-provided generator function.

generateAgents(Config, RandomGenerator) - Method in class modelarium.entities.generators.DefaultAgentGenerator

Generates a complete AgentSet based on the number of agents specified in the model settings.

generateAgentsForEachThread(Config, RandomGenerator) - Method in class modelarium.entities.generators.AgentGenerator

Generates the model's agents and distributes them across the model's worker cores.

generateAgentsForEachThread(Config, RandomGenerator) - Method in class modelarium.entities.generators.DefaultAgentGenerator

Distributes agents across processing threads in a round-robin fashion.

generateAgentsForEachThread(Config, RandomGenerator) - Method in class modelarium.entities.generators.FunctionalAgentGenerator

Generates the model's agents using the logic specified during construction and distributes them across the model's worker cores.

generateEnvironment(Config, RandomGenerator) - Method in class modelarium.entities.generators.EnvironmentGenerator

Creates and returns a fully initialised Environment for the simulation.

generateEnvironment(Config, RandomGenerator) - Method in class modelarium.entities.generators.FunctionalEnvironmentGenerator

Generates the environment by applying the user-provided generator function.

get() - Method in class modelarium.entities.attributes.properties.Property

Returns this property's current value.

get() - Method in class modelarium.entities.attributes.properties.ReadOnlyProperty

Returns this property's current value.

get(int) - Method in class modelarium.entities.agentsets.AgentSet

Retrieves an agent by index.

get(int) - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Retrieves an agent by index.

get(int) - Method in class modelarium.entities.attributes.sets.AgentAttributeSet

Retrieves a publicly accessible attribute by index.

get(int) - Method in class modelarium.entities.attributes.sets.AttributeSet

Retrieves a publicly accessible attribute by index.

get(int) - Method in class modelarium.entities.attributes.sets.EnvironmentAttributeSet

Retrieves a publicly accessible attribute by index.

get(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

Retrieves a deep clone of a publicly accessible attribute by index.

get(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Retrieves a deep clone of a publicly accessible attribute by index.

get(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyEnvironmentAttributeSet

Retrieves a deep clone of a publicly accessible attribute by index.

get(int) - Method in class modelarium.entities.logging.EntityLog

Retrieves an attribute set log by index.

get(C) - Method in class modelarium.entities.attributes.properties.Property

Returns this property's current value.

get(String) - Method in class modelarium.entities.agentsets.AgentSet

Retrieves an agent by name.

get(String) - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Retrieves an agent by name.

get(String) - Method in class modelarium.entities.attributes.sets.AgentAttributeSet

Retrieves a publicly accessible attribute by name.

get(String) - Method in class modelarium.entities.attributes.sets.AttributeSet

Retrieves a publicly accessible attribute by name.

get(String) - Method in class modelarium.entities.attributes.sets.EnvironmentAttributeSet

Retrieves a publicly accessible attribute by name.

get(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

Retrieves a deep clone of a publicly accessible attribute by name.

get(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Retrieves a deep clone of a publicly accessible attribute by name.

get(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyEnvironmentAttributeSet

Retrieves a deep clone of a publicly accessible attribute by name.

get(String) - Method in class modelarium.entities.logging.EntityLog

Retrieves an attribute set log by the name of its attribute set.

get(AgentContext) - Method in class modelarium.entities.attributes.properties.functional.FunctionalAgentProperty

Returns this property's value by applying the user-provided getter function.

get(AgentContext, T) - Method in interface modelarium.entities.attributes.properties.functional.AgentPropertyGetterFunction

Returns the property's value.

get(EnvironmentContext) - Method in class modelarium.entities.attributes.properties.functional.FunctionalEnvironmentProperty

Returns this property's value by applying the user-provided getter function.

get(EnvironmentContext, T) - Method in interface modelarium.entities.attributes.properties.functional.EnvironmentPropertyGetterFunction

Returns the property's value.

getAgent(String) - Method in interface modelarium.entities.contexts.Context

Retrieves an agent by name.

getAgent(String) - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Retrieves an agent by name.

getAgent(String) - Method in class modelarium.entities.contexts.SimulationContext

Retrieves an agent by name, whether it lives on this core or (in a synchronised model) on another core.

getAsImmutable() - Method in class modelarium.entities.Agent

Creates and returns an immutable version of this agent.

getAsImmutable() - Method in class modelarium.entities.agentsets.AgentSet

Returns a read-only view of this agent set.

getAsImmutable() - Method in interface modelarium.entities.attributes.Attribute

Creates and returns an immutable version of this attribute.

getAsImmutable() - Method in class modelarium.entities.attributes.events.Event

Creates and returns an immutable version of this attribute.

getAsImmutable() - Method in class modelarium.entities.attributes.properties.Property

Creates and returns an immutable version of this attribute.

getAsImmutable() - Method in class modelarium.entities.attributes.routines.Routine

Creates and returns an immutable version of this attribute.

getAsImmutable() - Method in class modelarium.entities.Entity

Creates and returns an immutable version of this entity.

getAsImmutable() - Method in class modelarium.entities.Environment

Creates and returns an immutable version of this environment.

getAsList() - Method in class modelarium.entities.agentsets.AgentSet

Returns the list of agents in this set.

getAsList() - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Returns the agents in this set as a list of read-only views.

getAttributeColumnAsList(String) - Method in class modelarium.entities.logging.databases.AttributeSetLogDatabase

Retrieves the named attribute's stored series.

getAttributeColumnAsList(String) - Method in class modelarium.entities.logging.databases.DiskBasedAttributeSetLogDatabase

Retrieves the named attribute's stored series, deserialising each value to the attribute's remembered class.

getAttributeColumnAsList(String) - Method in class modelarium.entities.logging.databases.MemoryBasedAttributeSetLogDatabase

Retrieves the named attribute's stored series.

getAttributeNamesList() - Method in class modelarium.entities.logging.AttributeSetLog

Returns the names of the attributes registered for logging.

getAttributeSet(int) - Method in class modelarium.entities.Agent

Retrieves an attribute set by index.

getAttributeSet(int) - Method in class modelarium.entities.Entity

Retrieves an attribute set by index.

getAttributeSet(int) - Method in class modelarium.entities.readonly.ReadOnlyAgent

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

getAttributeSet(int) - Method in class modelarium.entities.readonly.ReadOnlyEntity

Retrieves a read-only view of an attribute set by index.

getAttributeSet(int) - Method in class modelarium.entities.readonly.ReadOnlyEnvironment

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

getAttributeSet(String) - Method in class modelarium.entities.Agent

Retrieves an attribute set by name.

getAttributeSet(String) - Method in class modelarium.entities.Entity

Retrieves an attribute set by name.

getAttributeSet(String) - Method in class modelarium.entities.readonly.ReadOnlyAgent

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

getAttributeSet(String) - Method in class modelarium.entities.readonly.ReadOnlyEntity

Retrieves a read-only view of an attribute set by name.

getAttributeSet(String) - Method in class modelarium.entities.readonly.ReadOnlyEnvironment

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

getAttributeSetName() - Method in class modelarium.entities.logging.AttributeSetLog

Returns the name of the attribute set being logged.

getClock() - Method in interface modelarium.entities.contexts.Context

Returns the model's clock.

getClock() - Method in class modelarium.entities.contexts.SimulationContext

Returns the model's clock.

getCurrentPopulationSize() - Method in interface modelarium.entities.contexts.Context

Returns the model's current population size.

getCurrentPopulationSize() - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Returns the model's current population size.

getCurrentPopulationSize() - Method in class modelarium.entities.contexts.SimulationContext

Returns the model's current population size.

getDatabasePath() - Method in class modelarium.entities.logging.databases.AttributeSetLogDatabase

Returns the path of the database's backing file.

getEntityName() - Method in class modelarium.entities.logging.EntityLog

Returns the name of the entity this log belongs to.

getEnvironment() - Method in interface modelarium.entities.contexts.AgentContext

Returns the model's environment.

getEnvironment() - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Unsupported for the environment's own context.

getEnvironment() - Method in class modelarium.entities.contexts.SimulationContext

Returns the model's environment.

getEvent(int) - Method in class modelarium.entities.attributes.sets.AgentAttributeSet

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

getEvent(int) - Method in class modelarium.entities.attributes.sets.AttributeSet

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

getEvent(int) - Method in class modelarium.entities.attributes.sets.EnvironmentAttributeSet

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

getEvent(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

Retrieves a deep clone of an event by its index among the wrapped set's events.

getEvent(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Retrieves a deep clone of an event by its index among the wrapped set's events.

getEvent(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyEnvironmentAttributeSet

Retrieves a deep clone of an event by its index among the wrapped set's events.

getEvent(String) - Method in class modelarium.entities.attributes.sets.AgentAttributeSet

Retrieves an event by name.

getEvent(String) - Method in class modelarium.entities.attributes.sets.AttributeSet

Retrieves an event by name.

getEvent(String) - Method in class modelarium.entities.attributes.sets.EnvironmentAttributeSet

Retrieves an event by name.

getEvent(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

Retrieves a deep clone of an event by name.

getEvent(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Retrieves a deep clone of an event by name.

getEvent(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyEnvironmentAttributeSet

Retrieves a deep clone of an event by name.

getEvent(String, String) - Method in class modelarium.entities.Agent

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

getEvent(String, String) - Method in class modelarium.entities.Environment

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

getEvent(String, String) - Method in class modelarium.entities.readonly.ReadOnlyAgent

Retrieves a read-only view of an event attribute from one of the wrapped agent's attribute sets.

getEvent(String, String) - Method in class modelarium.entities.readonly.ReadOnlyEnvironment

Retrieves a read-only view of an event attribute from one of the wrapped environment's attribute sets.

getFilteredAgents(Predicate<ReadOnlyAgent>) - Method in class modelarium.entities.agentsets.AgentSet

Returns a living-only filtered view of the agent set.

getFilteredAgents(Predicate<ReadOnlyAgent>) - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Returns a living-only filtered view of the agent set.

getFilteredAgents(Predicate<ReadOnlyAgent>) - Method in interface modelarium.entities.contexts.Context

Retrieves the living-only agents matching a filter.

getFilteredAgents(Predicate<ReadOnlyAgent>) - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Retrieves the living-only agents matching a filter.

getFilteredAgents(Predicate<ReadOnlyAgent>) - Method in class modelarium.entities.contexts.SimulationContext

Retrieves the agents (excluding dead agents) matching a filter, drawn from the whole population in a synchronised model or from this core's local agents otherwise.

getFilteredAgents(Predicate<ReadOnlyAgent>, boolean) - Method in class modelarium.entities.agentsets.AgentSet

Returns a filtered view of the agent set.

getFilteredAgents(Predicate<ReadOnlyAgent>, boolean) - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Returns a filtered view of the agent set.

getFilteredAgents(Predicate<ReadOnlyAgent>, boolean) - Method in interface modelarium.entities.contexts.Context

Returns an agents matching a filter

getFilteredAgents(Predicate<ReadOnlyAgent>, boolean) - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Returns an agents matching a filter

getFilteredAgents(Predicate<ReadOnlyAgent>, boolean) - Method in class modelarium.entities.contexts.SimulationContext

Retrieves the agents matching a filter, drawn from the whole population in a synchronised model or from this core's local agents otherwise.

getLog() - Method in class modelarium.entities.attributes.sets.AttributeSet

Returns the log recording the values of this set's logged attributes.

getLog() - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Returns the log recording the values of the wrapped set's logged attributes.

getLog() - Method in class modelarium.entities.Entity

Returns the log of this entity's attribute values.

getLog() - Method in class modelarium.entities.readonly.ReadOnlyEntity

Returns the log of the wrapped entity's attribute values.

getMutableAttribute() - Method in class modelarium.entities.attributes.ReadOnlyAttribute

Returns the mutable version of this immutable attribute.

getMutableEntity() - Method in class modelarium.entities.readonly.ReadOnlyEntity

Returns the mutable entity this read-only view wraps.

getOwnerName() - Method in class modelarium.entities.logging.AttributeSetLog

Returns the name of the model element this log belongs to.

getProperty(int) - Method in class modelarium.entities.attributes.sets.AgentAttributeSet

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

getProperty(int) - Method in class modelarium.entities.attributes.sets.AttributeSet

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

getProperty(int) - Method in class modelarium.entities.attributes.sets.EnvironmentAttributeSet

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

getProperty(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

Retrieves a deep clone of a property by its index among the wrapped set's properties.

getProperty(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Retrieves a deep clone of a property by its index among the wrapped set's properties.

getProperty(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyEnvironmentAttributeSet

Retrieves a deep clone of a property by its index among the wrapped set's properties.

getProperty(String) - Method in class modelarium.entities.attributes.sets.AgentAttributeSet

Retrieves a property by name.

getProperty(String) - Method in class modelarium.entities.attributes.sets.AttributeSet

Retrieves a property by name.

getProperty(String) - Method in class modelarium.entities.attributes.sets.EnvironmentAttributeSet

Retrieves a property by name.

getProperty(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

Retrieves a deep clone of a property by name.

getProperty(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Retrieves a deep clone of a property by name.

getProperty(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyEnvironmentAttributeSet

Retrieves a deep clone of a property by name.

getProperty(String, String) - Method in class modelarium.entities.Agent

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

getProperty(String, String) - Method in class modelarium.entities.Environment

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

getProperty(String, String) - Method in class modelarium.entities.readonly.ReadOnlyAgent

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

getProperty(String, String) - Method in class modelarium.entities.readonly.ReadOnlyEnvironment

Retrieves a read-only view of a property attribute from one of the wrapped environment's attribute sets.

getPropertyType(String) - Method in class modelarium.entities.logging.AttributeSetLog

Returns the recorded value type of a given property.

getRandom() - Method in interface modelarium.entities.contexts.Context

Returns the random generator this model element can use.

getRandom() - Method in class modelarium.entities.contexts.SimulationContext

Returns the random generator the owning entity can use.

getRandomIterator(RandomGenerator) - Method in class modelarium.entities.agentsets.AgentSet

Returns a randomised iterator over the agents in this set.

getRandomIterator(RandomGenerator) - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Returns a randomised iterator over the agents in this set.

getResults() - Method in class modelarium.Model

Returns the results of the most recent model run.

getRoutine(int) - Method in class modelarium.entities.attributes.sets.AgentAttributeSet

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

getRoutine(int) - Method in class modelarium.entities.attributes.sets.AttributeSet

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

getRoutine(int) - Method in class modelarium.entities.attributes.sets.EnvironmentAttributeSet

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

getRoutine(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

Retrieves a deep clone of a routine by its index among the wrapped set's routines.

getRoutine(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Retrieves a deep clone of a routine by its index among the wrapped set's routines.

getRoutine(int) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyEnvironmentAttributeSet

Retrieves a deep clone of a routine by its index among the wrapped set's routines.

getRoutine(String) - Method in class modelarium.entities.attributes.sets.AgentAttributeSet

Retrieves a routine by name.

getRoutine(String) - Method in class modelarium.entities.attributes.sets.AttributeSet

Retrieves a routine by name.

getRoutine(String) - Method in class modelarium.entities.attributes.sets.EnvironmentAttributeSet

Retrieves a routine by name.

getRoutine(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

Retrieves a deep clone of a routine by name.

getRoutine(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Retrieves a deep clone of a routine by name.

getRoutine(String) - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyEnvironmentAttributeSet

Retrieves a deep clone of a routine by name.

getRoutine(String, String) - Method in class modelarium.entities.Agent

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

getRoutine(String, String) - Method in class modelarium.entities.Environment

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

getRoutine(String, String) - Method in class modelarium.entities.readonly.ReadOnlyAgent

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

getRoutine(String, String) - Method in class modelarium.entities.readonly.ReadOnlyEnvironment

Retrieves a read-only view of a routine attribute from one of the wrapped environment's attribute sets.

getThisAttribute() - Method in interface modelarium.entities.contexts.AgentContext

Returns the attribute currently being run on the owning agent.

getThisAttribute() - Method in class modelarium.entities.contexts.AgentSimulationContext

Returns the attribute currently being run on the owning agent.

getThisAttribute() - Method in interface modelarium.entities.contexts.EnvironmentContext

Returns the attribute currently being run on the owning environment.

getThisAttribute() - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Returns the attribute currently being run on the owning environment.

getThisAttribute() - Method in class modelarium.entities.contexts.SimulationContext

Returns the attribute currently being run on the owning entity.

getThisAttributeSet() - Method in interface modelarium.entities.contexts.AgentContext

Returns the attribute set currently being run on the owning agent.

getThisAttributeSet() - Method in class modelarium.entities.contexts.AgentSimulationContext

Returns the attribute set currently being run on the owning agent.

getThisAttributeSet() - Method in interface modelarium.entities.contexts.EnvironmentContext

Returns the attribute set currently being run on the owning environment.

getThisAttributeSet() - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Returns the attribute set currently being run on the owning environment.

getThisAttributeSet() - Method in class modelarium.entities.contexts.SimulationContext

Returns the attribute set currently being run on the owning entity.

getThisEntity() - Method in interface modelarium.entities.contexts.AgentContext

Returns the agent this context belongs to.

getThisEntity() - Method in class modelarium.entities.contexts.AgentSimulationContext

Returns the agent this context belongs to.

getThisEntity() - Method in interface modelarium.entities.contexts.EnvironmentContext

Returns the environment this context belongs to.

getThisEntity() - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Returns the environment this context belongs to.

getThisEntity() - Method in class modelarium.entities.contexts.SimulationContext

Returns the entity this context belongs to.

getValues(String) - Method in class modelarium.entities.logging.AttributeSetLog

Retrieves the values recorded for the named attribute across the model run.

H

hashCode() - Method in record class modelarium.Config

Returns a hash code value for this object.

hashCode() - Method in record class modelarium.multithreading.CoordinatorHandle

Returns a hash code value for this object.

I

InOrderScheduler - Class in modelarium.scheduler

Class for scheduling agents to execute in the order they appear in the agent set.

InOrderScheduler() - Constructor for class modelarium.scheduler.InOrderScheduler

Constructs an in-order scheduler.

isDead() - Method in class modelarium.entities.Agent

Returns whether the agent is dead or not.

isDead() - Method in class modelarium.entities.readonly.ReadOnlyAgent

Returns whether the agent is dead or not.

isEmpty() - Method in class modelarium.entities.agentsets.AgentSet

Returns whether the set contains no agents.

isEmpty() - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Returns whether the set contains no agents.

isFinished() - Method in class modelarium.clock.ReadOnlyClock

Returns whether the model has performed all of its ticks.

isLogged() - Method in interface modelarium.entities.attributes.Attribute

Returns whether this attribute's state is logged as the model progresses.

isLogged() - Method in class modelarium.entities.attributes.AttributeBase

Returns whether this attribute's state is logged as the model progresses.

isLogged() - Method in class modelarium.entities.attributes.ReadOnlyAttribute

Returns whether this attribute's state is logged as the model progresses.

isTriggered() - Method in class modelarium.entities.attributes.events.Event

Returns whether this event's trigger condition is currently met.

isTriggered() - Method in class modelarium.entities.attributes.events.ReadOnlyEvent

Returns whether this event's trigger condition is currently met.

isTriggered(C) - Method in class modelarium.entities.attributes.events.Event

Determines whether this event's trigger condition is met.

isTriggered(AgentContext) - Method in interface modelarium.entities.attributes.events.functional.AgentEventIsTriggeredFunction

Determines whether the event's trigger condition is met.

isTriggered(AgentContext) - Method in class modelarium.entities.attributes.events.functional.FunctionalAgentEvent

Determines whether this event's trigger condition is met by applying the user-provided trigger function.

isTriggered(EnvironmentContext) - Method in interface modelarium.entities.attributes.events.functional.EnvironmentEventIsTriggeredFunction

Determines whether the event's trigger condition is met.

isTriggered(EnvironmentContext) - Method in class modelarium.entities.attributes.events.functional.FunctionalEnvironmentEvent

Determines whether this event's trigger condition is met by applying the user-provided trigger function.

iterator() - Method in class modelarium.entities.agentsets.AgentSet

Standard iterator over the agents in the order they were added.

iterator() - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Standard iterator over the agents in the order they were added.

K

kill() - Method in class modelarium.entities.Agent

Sets the agent to the removed state (killed) so that it no longer functions or contributes to the simulation.

killAgent(String) - Method in interface modelarium.entities.contexts.Context

Kills the agent with the given name.

killAgent(String) - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Kills the agent with the given name.

killAgent(String) - Method in class modelarium.entities.contexts.SimulationContext

Kills the agent with the given name.

killAgent(ReadOnlyAgent) - Method in interface modelarium.entities.contexts.Context

Kills the agent of the given ReadOnlyAgent instance.

killAgent(ReadOnlyAgent) - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Kills the agent of the given ReadOnlyAgent instance.

killAgent(ReadOnlyAgent) - Method in class modelarium.entities.contexts.SimulationContext

Kills the agent of the given ReadOnlyAgent instance.

killAgents(List<String>) - Method in interface modelarium.entities.contexts.Context

Kills all the agents with names in a given List<String> instance.

killAgents(List<String>) - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Kills all the agents with names in a given List<String> instance.

killAgents(List<String>) - Method in class modelarium.entities.contexts.SimulationContext

Kills all the agents with names in a given List<String> instance.

killAgents(ReadOnlyAgentSet) - Method in interface modelarium.entities.contexts.Context

Kills all the agents in a given ReadOnlyAgentSet instance.

killAgents(ReadOnlyAgentSet) - Method in class modelarium.entities.contexts.EnvironmentSimulationContext

Kills all the agents in a given ReadOnlyAgentSet instance.

killAgents(ReadOnlyAgentSet) - Method in class modelarium.entities.contexts.SimulationContext

Kills all the agents in a given ReadOnlyAgentSet instance.

L

localAgentSet() - Method in class modelarium.entities.contexts.SimulationContext

Returns the entity's local agent set.

M

Main extension points - Search tag in Overview

Section

MemoryBasedAttributeSetLogDatabase - Class in modelarium.entities.logging.databases

An in-memory implementation of AttributeSetLogDatabase.

MemoryBasedAttributeSetLogDatabase() - Constructor for class modelarium.entities.logging.databases.MemoryBasedAttributeSetLogDatabase

Constructs a new in-memory attribute set log database.

MemoryBasedAttributeSetLogDatabaseFactory - Class in modelarium.entities.logging.databases.factories

Class for creating memory-based attribute set log databases.

MemoryBasedAttributeSetLogDatabaseFactory() - Constructor for class modelarium.entities.logging.databases.factories.MemoryBasedAttributeSetLogDatabaseFactory

Constructs a factory for memory-backed attribute-set log databases.

MissingAttributeFunctionException - Exception Class in modelarium.exceptions

Exception for indicating that a functional attribute was used without a required logic function.

MissingAttributeFunctionException(String) - Constructor for exception class modelarium.exceptions.MissingAttributeFunctionException

Constructs a new missing attribute function exception with the specified detail message.

Model - Class in modelarium

Main class for executing an agent-based model using multithreaded execution.

Model(Config) - Constructor for class modelarium.Model

Constructs a new model instance with the specified settings.

modelarium - package modelarium

Provides Modelarium's primary configuration and execution API.

modelarium.api - package modelarium.api

Defines annotations used to identify Modelarium's supported public API.

modelarium.clock - package modelarium.clock

Provides read-only access to simulation time.

modelarium.entities - package modelarium.entities

Defines the agents and environment which make up a Modelarium simulation.

modelarium.entities.agentsets - package modelarium.entities.agentsets

Provides mutable and read-only collections of agents.

modelarium.entities.attributes - package modelarium.entities.attributes

Defines the common API for Modelarium attributes.

modelarium.entities.attributes.events - package modelarium.entities.attributes.events

Provides conditional event attributes for agents and environments.

modelarium.entities.attributes.events.functional - package modelarium.entities.attributes.events.functional

Provides functional interfaces and lambda-backed implementations of event attributes.

modelarium.entities.attributes.properties - package modelarium.entities.attributes.properties

Provides typed state-bearing properties for agents and environments.

modelarium.entities.attributes.properties.functional - package modelarium.entities.attributes.properties.functional

Provides functional interfaces and lambda-backed implementations of property attributes.

modelarium.entities.attributes.routines - package modelarium.entities.attributes.routines

Provides unconditional per-tick routines for agents and environments.

modelarium.entities.attributes.routines.functional - package modelarium.entities.attributes.routines.functional

Provides functional interfaces and lambda-backed implementations of routine attributes.

modelarium.entities.attributes.sets - package modelarium.entities.attributes.sets

Provides named, ordered collections of agent and environment attributes.

modelarium.entities.attributes.sets.readonly - package modelarium.entities.attributes.sets.readonly

Provides read-only views of agent and environment attribute sets.

modelarium.entities.contexts - package modelarium.entities.contexts

Defines the simulation views supplied to attribute behaviour.

modelarium.entities.generators - package modelarium.entities.generators

Provides extension points for constructing a model's agents and environment.

modelarium.entities.logging - package modelarium.entities.logging

Provides logs which associate an entity and attribute set with recorded attribute series.

modelarium.entities.logging.databases - package modelarium.entities.logging.databases

Provides memory- and disk-backed storage for attribute log series.

modelarium.entities.logging.databases.factories - package modelarium.entities.logging.databases.factories

Provides factories which select and create the logging backend used by a model run.

modelarium.entities.readonly - package modelarium.entities.readonly

Provides read-only views of agents, environments, and their common entity state.

modelarium.exceptions - package modelarium.exceptions

Defines Modelarium-specific failures for model execution, entity lookup, attribute access, coordination, timeouts, interruption, and missing functional behaviour.

modelarium.multithreading - package modelarium.multithreading

Implements Modelarium's worker and co-ordinator runtime.

modelarium.results.readonly - package modelarium.results.readonly

Provides immutable access to completed model results and result export.

modelarium.scheduler - package modelarium.scheduler

Provides policies for ordering local agent execution on each tick.

modelarium.scheduler.functional - package modelarium.scheduler.functional

Provides a lambda-backed scheduler and its tick function interface.

modelarium.utils - package modelarium.utils

Provides small public utility types used by Modelarium extension points.

Modelarium API - Search tag in Overview

Section

ModelRunException - Exception Class in modelarium.exceptions

Exception for indicating that a model run failed to complete.

ModelRunException(String, Throwable) - Constructor for exception class modelarium.exceptions.ModelRunException

Constructs a new model run exception with the specified detail message and cause.

N

name() - Method in interface modelarium.entities.attributes.Attribute

Returns the name of this attribute.

name() - Method in class modelarium.entities.attributes.AttributeBase

Returns the name of this attribute.

name() - Method in class modelarium.entities.attributes.ReadOnlyAttribute

Returns the name of this attribute.

name() - Method in class modelarium.entities.attributes.sets.AttributeSet

Returns the name of this attribute set.

name() - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Returns the name of the wrapped attribute set.

name() - Method in class modelarium.entities.Entity

Returns the name of this entity.

name() - Method in class modelarium.entities.readonly.ReadOnlyEntity

Returns the name of the wrapped entity.

P

populationSize() - Method in record class modelarium.Config

Returns the value of the populationSize record component.

populationSize(int) - Method in class modelarium.Config.ConfigBuilder

Sets the model's population size.

PRIVATE - Enum constant in enum class modelarium.entities.attributes.AttributeAccessLevel

Indicates that the attribute can only be accessed by the entity that owns it.

Property<T,C> - Class in modelarium.entities.attributes.properties

Abstract class for representing an attribute that carries a typed value.

PUBLIC - Enum constant in enum class modelarium.entities.attributes.AttributeAccessLevel

Indicates that the attribute can be read by other entities.

PublicApi - Annotation Interface in modelarium.api

Marks a package or element as part of Modelarium's supported public API.

Q

QuadFunction<A,B,C,D,R> - Interface in modelarium.utils

Functional interface for representing a function that accepts four arguments and produces a result.

R

RandomOrderScheduler - Class in modelarium.scheduler

Class for scheduling agents to execute in a randomised order for each tick.

RandomOrderScheduler() - Constructor for class modelarium.scheduler.RandomOrderScheduler

Constructs a random-order scheduler.

ReadOnlyAgent - Class in modelarium.entities.readonly

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

ReadOnlyAgent(Agent) - Constructor for class modelarium.entities.readonly.ReadOnlyAgent

Constructs a new immutable agent wrapping the specified mutable agent.

ReadOnlyAgentAttributeSet - Class in modelarium.entities.attributes.sets.readonly

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

ReadOnlyAgentAttributeSet(AgentAttributeSet) - Constructor for class modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

Constructs a new immutable agent attribute set wrapping the specified mutable attribute set.

ReadOnlyAgentSet - Class in modelarium.entities.agentsets

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

ReadOnlyAgentSet(AgentSet) - Constructor for class modelarium.entities.agentsets.ReadOnlyAgentSet

Constructs a new immutable agent set wrapping the specified mutable agent set.

ReadOnlyAttribute<T> - Class in modelarium.entities.attributes

Class for providing a read-only view of an Attribute

ReadOnlyAttribute(T) - Constructor for class modelarium.entities.attributes.ReadOnlyAttribute

Constructs a new immutable attribute wrapping the specified mutable attribute.

ReadOnlyAttributeSet<SC,C> - Class in modelarium.entities.attributes.sets.readonly

Abstract class for providing a read-only view of an AttributeSet.

ReadOnlyAttributeSet(AttributeSet<SC, C>) - Constructor for class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Constructs a new immutable attribute set wrapping the specified mutable attribute set.

ReadOnlyClock - Class in modelarium.clock

Class for providing a read-only view of a Clock.

ReadOnlyEntity<SC,C,AS,ASL> - Class in modelarium.entities.readonly

Abstract class for providing a read-only view of an Entity.

ReadOnlyEntity(Entity<SC, C, AS, ASL>) - Constructor for class modelarium.entities.readonly.ReadOnlyEntity

Constructs a new immutable entity wrapping the specified mutable entity.

ReadOnlyEnvironment - Class in modelarium.entities.readonly

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

ReadOnlyEnvironment(Environment) - Constructor for class modelarium.entities.readonly.ReadOnlyEnvironment

Constructs a new immutable environment wrapping the specified mutable environment.

ReadOnlyEnvironmentAttributeSet - Class in modelarium.entities.attributes.sets.readonly

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

ReadOnlyEnvironmentAttributeSet(EnvironmentAttributeSet) - Constructor for class modelarium.entities.attributes.sets.readonly.ReadOnlyEnvironmentAttributeSet

Constructs a new immutable environment attribute set wrapping the specified mutable attribute set.

ReadOnlyEvent - Class in modelarium.entities.attributes.events

Provides a read-only view of an event attribute.

ReadOnlyProperty<T> - Class in modelarium.entities.attributes.properties

Provides a read-only view of a typed property attribute.

ReadOnlyResults - Class in modelarium.results.readonly

Class for providing a read-only view of the results of a model run.

ReadOnlyResultsForAgents - Class in modelarium.results.readonly

Class for providing a read-only view of the model's agent-level results.

ReadOnlyResultsForEnvironment - Class in modelarium.results.readonly

Class for providing a read-only view of the model's environment-level results.

ReadOnlyRoutine - Class in modelarium.entities.attributes.routines

Provides a read-only view of a routine attribute.

record(String, Object) - Method in class modelarium.entities.logging.AttributeSetLog

Records a value for the named attribute at the current tick.

reset() - Method in class modelarium.entities.generators.AgentGenerator

Resets any temporary state retained while generating a population.

reset() - Method in class modelarium.entities.generators.EnvironmentGenerator

Resets any temporary state retained while generating an environment.

reset() - Method in class modelarium.entities.generators.FunctionalAgentGenerator

Resets the state of the generator.

reset() - Method in class modelarium.entities.generators.FunctionalEnvironmentGenerator

Resets the state of the generator.

Routine<C> - Class in modelarium.entities.attributes.routines

Abstract class for representing an attribute whose behaviour runs unconditionally every tick.

run() - Method in class modelarium.entities.Agent

Runs each of this agent's attribute sets for the current tick unless it is dead.

run() - Method in interface modelarium.entities.attributes.Attribute

Runs this attribute's behaviour for the current tick.

run() - Method in class modelarium.entities.attributes.events.Event

Runs this event's behaviour for the current tick.

run() - Method in class modelarium.entities.attributes.properties.Property

Runs this property's behaviour for the current tick.

run() - Method in class modelarium.entities.attributes.routines.Routine

Runs this routine's behaviour for the current tick.

run() - Method in class modelarium.entities.attributes.sets.AttributeSet

Runs each of this set's attributes in order for the current tick, recording the values of logged attributes.

run() - Method in class modelarium.entities.Entity

Runs each of this entity's attribute sets for the current tick.

run() - Method in class modelarium.Model

Runs the model using the configurations given during construction.

run() - Method in class modelarium.multithreading.CoordinatorThread

Main execution loop for the coordinator thread.

run(C) - Method in class modelarium.entities.attributes.events.Event

Runs this event's behaviour.

run(C) - Method in class modelarium.entities.attributes.properties.Property

Runs this property's behaviour (does nothing by default).

run(C) - Method in class modelarium.entities.attributes.routines.Routine

Runs this routine's behaviour.

run(AgentContext) - Method in interface modelarium.entities.attributes.events.functional.AgentEventRunFunction

Runs the event's behaviour.

run(AgentContext) - Method in class modelarium.entities.attributes.events.functional.FunctionalAgentEvent

Runs this event's behaviour by applying the user-provided run function.

run(AgentContext) - Method in class modelarium.entities.attributes.properties.functional.FunctionalAgentProperty

Runs this property's behaviour by applying the user-provided run function and storing its result.

run(AgentContext) - Method in interface modelarium.entities.attributes.routines.functional.AgentRoutineRunFunction

Runs the routine's behaviour.

run(AgentContext) - Method in class modelarium.entities.attributes.routines.functional.FunctionalAgentRoutine

Runs this routine's behaviour by applying the user-provided run function.

run(AgentContext, T) - Method in interface modelarium.entities.attributes.properties.functional.AgentPropertyRunFunction

Runs the property's behaviour.

run(EnvironmentContext) - Method in interface modelarium.entities.attributes.events.functional.EnvironmentEventRunFunction

Runs the event's behaviour.

run(EnvironmentContext) - Method in class modelarium.entities.attributes.events.functional.FunctionalEnvironmentEvent

Runs this event's behaviour by applying the user-provided run function.

run(EnvironmentContext) - Method in class modelarium.entities.attributes.properties.functional.FunctionalEnvironmentProperty

Runs this property's behaviour by applying the user-provided run function and storing its result.

run(EnvironmentContext) - Method in interface modelarium.entities.attributes.routines.functional.EnvironmentRoutineRunFunction

Runs the routine's behaviour.

run(EnvironmentContext) - Method in class modelarium.entities.attributes.routines.functional.FunctionalEnvironmentRoutine

Runs this routine's behaviour by applying the user-provided run function.

run(EnvironmentContext, T) - Method in interface modelarium.entities.attributes.properties.functional.EnvironmentPropertyRunFunction

Runs the property's behaviour.

runLogDatabaseFactory() - Method in record class modelarium.Config

Returns the value of the runLogDatabaseFactory record component.

runLogDatabaseFactory(AttributeSetLogDatabaseFactory) - Method in class modelarium.Config.ConfigBuilder

(Optional) Sets the AttributeSetLogDatabaseFactory instance the model will use to generate the database for storing the attribute logs of each entity.

runTick(String, ReadOnlyClock, ReadOnlyEnvironment, AgentSet, RandomGenerator) - Method in class modelarium.scheduler.functional.FunctionalScheduler

Executes a single simulation tick by delegating to the user-provided function.

runTick(String, ReadOnlyClock, ReadOnlyEnvironment, AgentSet, RandomGenerator) - Method in interface modelarium.scheduler.functional.TickFunction

Executes a single simulation tick for the provided agent set.

runTick(String, ReadOnlyClock, ReadOnlyEnvironment, AgentSet, RandomGenerator) - Method in class modelarium.scheduler.InOrderScheduler

Executes each agent's run() method in the order they are stored in the agent set.

runTick(String, ReadOnlyClock, ReadOnlyEnvironment, AgentSet, RandomGenerator) - Method in class modelarium.scheduler.RandomOrderScheduler

Executes each agent's run() method in a randomised order.

runTick(String, ReadOnlyClock, ReadOnlyEnvironment, AgentSet, RandomGenerator) - Method in interface modelarium.scheduler.Scheduler

Executes a single simulation tick for the provided agent set.

S

scheduler() - Method in record class modelarium.Config

Returns the value of the scheduler record component.

scheduler(Scheduler) - Method in class modelarium.Config.ConfigBuilder

(Optional) Sets the Scheduler instance the model will use to sequence the running of agents at each time step.

Scheduler - Interface in modelarium.scheduler

Interface for representing a scheduling policy for running a single tick of the agent-based model.

seed() - Method in record class modelarium.Config

Returns the value of the seed record component.

seed(long) - Method in class modelarium.Config.ConfigBuilder

(Optional) Sets the seed value the model will use to generate its core random generator which model components and entities can then use.

set(C, T) - Method in class modelarium.entities.attributes.properties.Property

Sets this property's value.

set(AgentContext, T) - Method in class modelarium.entities.attributes.properties.functional.FunctionalAgentProperty

Sets this property's value by applying the user-provided setter function and storing its result.

set(AgentContext, T, T) - Method in interface modelarium.entities.attributes.properties.functional.AgentPropertySetterFunction

Sets the property's value.

set(EnvironmentContext, T) - Method in class modelarium.entities.attributes.properties.functional.FunctionalEnvironmentProperty

Sets this property's value by applying the user-provided setter function and storing its result.

set(EnvironmentContext, T, T) - Method in interface modelarium.entities.attributes.properties.functional.EnvironmentPropertySetterFunction

Sets the property's value.

set(T) - Method in class modelarium.entities.attributes.properties.Property

Sets this property's value.

setAttributeColumn(String, List<Object>) - Method in class modelarium.entities.logging.databases.AttributeSetLogDatabase

Replaces the named attribute's stored series with the given values.

setAttributeColumn(String, List<Object>) - Method in class modelarium.entities.logging.databases.DiskBasedAttributeSetLogDatabase

Replaces the named attribute's stored series with the given values, inferring the attribute's value type from the first non-null value.

setAttributeColumn(String, List<Object>) - Method in class modelarium.entities.logging.databases.MemoryBasedAttributeSetLogDatabase

Replaces the named attribute's stored series with a copy of the given values, inferring the attribute's value type from the first non-null value.

shutdown() - Method in class modelarium.multithreading.CoordinatorThread

Signals the coordinator thread to stop processing and terminate.

SimulationContext - Class in modelarium.entities.contexts

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.

SimulationInterruptedException - Exception Class in modelarium.exceptions

Exception for indicating that a simulation thread was interrupted while waiting on another thread.

SimulationInterruptedException(String, Throwable) - Constructor for exception class modelarium.exceptions.SimulationInterruptedException

Constructs a new simulation interrupted exception with the specified detail message and cause.

size() - Method in class modelarium.entities.agentsets.AgentSet

Returns the number of agents in the set.

size() - Method in class modelarium.entities.agentsets.ReadOnlyAgentSet

Returns the number of agents in the set.

size() - Method in class modelarium.entities.attributes.sets.AttributeSet

Returns the number of attributes in this set.

size() - Method in class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

Returns the number of attributes in the wrapped set.

Starting a model - Search tag in Overview

Section

T

threadCount() - Method in record class modelarium.Config

Returns the value of the threadCount record component.

threadCount(int) - Method in class modelarium.Config.ConfigBuilder

Sets the number of worker threads the model will use to run.

threadTimeout() - Method in record class modelarium.Config

Returns the value of the threadTimeout record component.

threadTimeout(Duration) - Method in class modelarium.Config.ConfigBuilder

(Optional) Sets the duration of time needed before a thread's request to another thread times out.

tickCount() - Method in record class modelarium.Config

Returns the value of the tickCount record component.

tickCount(int) - Method in class modelarium.Config.ConfigBuilder

Sets the number of ticks in the model.

TickFunction - Interface in modelarium.scheduler.functional

Functional interface for defining how a functional scheduler runs a single tick over a set of agents.

toString() - Method in record class modelarium.Config

Returns a string representation of this record class.

toString() - Method in class modelarium.entities.attributes.events.Event

Returns the string representation of the event's triggered status.

toString() - Method in class modelarium.entities.attributes.events.ReadOnlyEvent

Returns the string representation of the event's triggered status.

toString() - Method in class modelarium.entities.attributes.properties.Property

Returns the string representation of the property value.

toString() - Method in class modelarium.entities.attributes.properties.ReadOnlyProperty

Returns the string representation of the property value.

toString() - Method in record class modelarium.multithreading.CoordinatorHandle

Returns a string representation of this record class.

totalTickCount() - Method in class modelarium.clock.ReadOnlyClock

Returns the total number of ticks the model will perform.

type() - Method in class modelarium.entities.attributes.properties.Property

Returns the class of the value this property carries.

type() - Method in class modelarium.entities.attributes.properties.ReadOnlyProperty

Returns the class of the value this property carries.

U

update(AgentSet, boolean) - Method in class modelarium.entities.agentsets.AgentSet

Updates this set with all agents from another set.

V

valueOf(String) - Static method in enum class modelarium.entities.attributes.AttributeAccessLevel

Returns the enum constant of this class with the specified name.

values() - Static method in enum class modelarium.entities.attributes.AttributeAccessLevel

Returns an array containing the constants of this enum class, in the order they are declared.

W

WorkerThread - Class in modelarium.multithreading

Represents a single worker thread responsible for simulating one subset of agents across the configured number of ticks.

WorkerThread(String, Config, RequestResponseController, Environment, AgentSet, Clock, RandomGenerator) - Constructor for class modelarium.multithreading.WorkerThread

Constructs a new worker thread to simulate a subset of agents.

A B C D E F G H I K L M N P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form