simudyne.core.abm

Interface AgentSystem<S extends GlobalState>

All Superinterfaces:

JSONValue

public interface AgentSystem<S extends GlobalState>
extends JSONValue

Method Summary

Modifier and Type	Method and Description
void	beginStep() reset all the accumulator that haven't been flagged as persistent
static AgentSystem<GlobalState>	create()
static <S extends GlobalState> AgentSystem<S>	create(S globalState)
default DoubleAccumulator	createDoubleAccumulator(java.lang.String name) createDoubleAccumulator(String, String) using the name for reporting purposes.
default DoubleAccumulator	createDoubleAccumulator(java.lang.String name, java.lang.String displayName) Create a DoubleAccumulator.
default LongAccumulator	createLongAccumulator(java.lang.String name) createLongAccumulator(String, String) using the name for reporting purposes.
default LongAccumulator	createLongAccumulator(java.lang.String name, java.lang.String displayName) Create a LongAccumulator.
default <T extends Agent<S>> Group<T>	generateGroup(java.lang.Class<T> agentClass, long size) generateGroup(Class, long, SerializableConsumer) without a data injector so no initial function is run for agents
<T extends Agent<S>> Group<T>	generateGroup(java.lang.Class<T> agentClass, long size, SerializableConsumer<T> dataInjector) Create a Group of agents.
Graph<S>	getBackendGraph()
DoubleAccumulator	getDoubleAccumulator(java.lang.String name)
java.util.Map<java.lang.String,DoubleAccumulator>	getDoubleAccumulators()
S	getGlobals()
LongAccumulator	getLongAccumulator(java.lang.String name)
java.util.Map<java.lang.String,LongAccumulator>	getLongAccumulators()
default <T extends Agent<S>> Group<T>	loadGroup(java.lang.Class<T> clazz, Source source) loadGroup(Class, Source, SerializableConsumer) without a data injector so no initial function is run for agents
<T extends Agent<S>> Group<T>	loadGroup(java.lang.Class<T> agentClass, Source source, SerializableConsumer<T> dataInjector) Create a Group of agents using data loaded from a Source.
void	registerAgentType(java.lang.Class<? extends Vertex<S>> type)
void	registerLinkTypes(java.lang.Class... types)
default void	registerLinkTypesContainer(java.lang.Class container)
void	registerMessageTypes(java.lang.Class... types)
default void	registerMessageTypesContainer(java.lang.Class container)
<T extends Agent<S>> AgentSelection<T>	select(java.lang.Class<T> agentType) Select all agents of a given type from the system.
void	setup()
<T extends Agent<S>> AgentStatistics<T>	stats(java.lang.Class<T> agentType) Select all agents of a given type from the system, for summarization through AgentStatistics.

Methods inherited from interface simudyne.core.JSONValue

emitJSON, getRecord, getSchema, getValues, receiveJSON

Method Detail

create

static <S extends GlobalState> AgentSystem<S> create(S globalState)

create

static AgentSystem<GlobalState> create()

generateGroup

default <T extends Agent<S>> Group<T> generateGroup(java.lang.Class<T> agentClass,
                                                    long size)

generateGroup(Class, long, SerializableConsumer) without a data injector so no initial function is run for agents

generateGroup

<T extends Agent<S>> Group<T> generateGroup(java.lang.Class<T> agentClass,
                                            long size,
                                            SerializableConsumer<T> dataInjector)

Create a Group of agents.

Type Parameters:

T - Agent Type

Parameters:

agentClass - Agent Class of agents to be created in this group

size - Number of agents to create in this group

dataInjector - Function run when each agent is created which can be used to set initialization values of agent

Returns:

A Group instance

loadGroup

default <T extends Agent<S>> Group<T> loadGroup(java.lang.Class<T> clazz,
                                                Source source)

loadGroup(Class, Source, SerializableConsumer) without a data injector so no initial function is run for agents

loadGroup

<T extends Agent<S>> Group<T> loadGroup(java.lang.Class<T> agentClass,
                                        Source source,
                                        SerializableConsumer<T> dataInjector)

Create a Group of agents using data loaded from a Source.

Type Parameters:

T - Agent Type

Parameters:

agentClass - Agent Class of agents to be created in this group

source - Source instance

dataInjector - Function run when each agent is created which can be used to set initialization values of agent

Returns:

A Group instance

setup

void setup()

getBackendGraph

Graph<S> getBackendGraph()

getGlobals

S getGlobals()

Returns:

Globally available object of type S. This object is created and added to system with create(GlobalState)) If no global state was added, GlobalState is returned.

registerAgentType

void registerAgentType(java.lang.Class<? extends Vertex<S>> type)

registerMessageTypes

void registerMessageTypes(java.lang.Class... types)

registerMessageTypesContainer

default void registerMessageTypesContainer(java.lang.Class container)

registerLinkTypes

void registerLinkTypes(java.lang.Class... types)

registerLinkTypesContainer

default void registerLinkTypesContainer(java.lang.Class container)

select

<T extends Agent<S>> AgentSelection<T> select(java.lang.Class<T> agentType)

Select all agents of a given type from the system. Returns an AgentSelection which allows further refinement of the selection through filters, and finally retrieving a result through aggregation.

Type Parameters:

T - Agent Type

Parameters:

agentType - Agent Class

stats

<T extends Agent<S>> AgentStatistics<T> stats(java.lang.Class<T> agentType)

Select all agents of a given type from the system, for summarization through AgentStatistics. AgentStatistics allows refinement of the agents selected, and the definition of fields (or computed fields) for which statistics will be collected.

Type Parameters:

T - Agent Type

Parameters:

agentType - Agent Class

createLongAccumulator

default LongAccumulator createLongAccumulator(java.lang.String name)

createLongAccumulator(String, String) using the name for reporting purposes.

createDoubleAccumulator

default DoubleAccumulator createDoubleAccumulator(java.lang.String name)

createDoubleAccumulator(String, String) using the name for reporting purposes.

createLongAccumulator

default LongAccumulator createLongAccumulator(java.lang.String name,
                                              java.lang.String displayName)

Create a LongAccumulator.

Parameters:

name - Name used to access this accumulator

displayName - Name used for reporting the result of this accumulator

Returns:

A LongAccumulator instance

createDoubleAccumulator

default DoubleAccumulator createDoubleAccumulator(java.lang.String name,
                                                  java.lang.String displayName)

Create a DoubleAccumulator.

Parameters:

name - Name used to access this accumulator

displayName - Name used for reporting the result of this accumulator

Returns:

A LongAccumulator instance

getLongAccumulator

LongAccumulator getLongAccumulator(java.lang.String name)

getDoubleAccumulator

DoubleAccumulator getDoubleAccumulator(java.lang.String name)

getDoubleAccumulators

java.util.Map<java.lang.String,DoubleAccumulator> getDoubleAccumulators()

getLongAccumulators

java.util.Map<java.lang.String,LongAccumulator> getLongAccumulators()

beginStep

void beginStep()

reset all the accumulator that haven't been flagged as persistent