simudyne.core.abm

Interface AgentSystem<S extends GlobalState>

All Superinterfaces:

JSONValue, java.io.Serializable

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(Model model)
static <S extends GlobalState> AgentSystem<S>	create(S globalState, Model model)
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.
void	done()
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()
Configuration	getConfig()
ModelContext	getContext()
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()
Model	getModel()
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	registerAgentTypes(java.lang.Class<? extends Vertex<S>>... type)
void	registerLinkTypes(java.lang.Class<? extends Link>... types)
void	registerMessageTypes(java.lang.Class<? extends Message>... types)
<T extends Agent<S>> AgentSelection<T>	select(java.lang.Class<T> agentType) Select all agents of a given type from the system.
<T extends Agent<S>> long	selectRandomAgent(java.lang.Class<T> agentType) Select one random agent
<T extends Agent<S>> java.util.List<java.lang.Long>	selectRandomAgents(java.lang.Class<T> agentType, int n) Select N random agents
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

getSchema, getValues, receiveJSON

Method Detail

create

static <S extends GlobalState> AgentSystem<S> create(S globalState,
                                                     Model model)

create

static AgentSystem<GlobalState> create(Model model)

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()

getModel

Model getModel()

getGlobals

S getGlobals()

Returns:

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

registerAgentTypes

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

registerMessageTypes

void registerMessageTypes(java.lang.Class<? extends Message>... types)

registerLinkTypes

void registerLinkTypes(java.lang.Class<? extends Link>... types)

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

done

void done()

getContext

ModelContext getContext()

getConfig

Configuration getConfig()

selectRandomAgent

<T extends Agent<S>> long selectRandomAgent(java.lang.Class<T> agentType)

Select one random agent

Type Parameters:

T -

Parameters:

agentType -

Returns:

Randomly selected agent ID

selectRandomAgents

<T extends Agent<S>> java.util.List<java.lang.Long> selectRandomAgents(java.lang.Class<T> agentType,
                                                                       int n)

Select N random agents

Type Parameters:

T -

Parameters:

agentType -

n - Number of agents to select

Returns:

List of randomly selected agent IDs