simudyne.core.abm

Class AgentBasedModel<T extends GlobalState>

java.lang.Object

simudyne.core.abm.AgentBasedModel<T>

All Implemented Interfaces:

Value, Model

public abstract class AgentBasedModel<T extends GlobalState>
extends java.lang.Object
implements Model

Field Summary

Fields

Modifier and Type	Field and Description
AgentSystem<T>	system

Constructor Summary

Constructors

Constructor and Description
AgentBasedModel()

Method Summary

Modifier and Type	Method and Description
DoubleAccumulator	createDoubleAccumulator(java.lang.String name) createDoubleAccumulator(String, String) using the name for reporting purposes.
DoubleAccumulator	createDoubleAccumulator(java.lang.String name, java.lang.String displayName) Create a DoubleAccumulator.
LongAccumulator	createLongAccumulator(java.lang.String name) createLongAccumulator(String, String) using the name for reporting purposes.
LongAccumulator	createLongAccumulator(java.lang.String name, java.lang.String displayName) Create a LongAccumulator.
void	done()
void	emitData(ModelContext context, ModelExecutionPhase phase)
void	enableAtomicLogging()
void	finish()
void	firstStep(Section... sections) Works like the AgentBasedModel#run(Section) function but only when time = 0
<A extends Agent<T>> Group<A>	generateGroup(boolean logger, java.lang.Class<A> agentClass, long size)
<A extends Agent<T>> Group<A>	generateGroup(java.lang.Class<A> agentClass, long size) generateGroup(Class, long, SerializableConsumer) without a data injector so no initial function is run for agents
<A extends Agent<T>> Group<A>	generateGroup(java.lang.Class<A> agentClass, long size, SerializableConsumer<A> dataInjector) Create a Group of agents.
Configuration	getConfig()
ModelContext	getContext()
DoubleAccumulator	getDoubleAccumulator(java.lang.String name)
T	getGlobals()
LongAccumulator	getLongAccumulator(java.lang.String name)
AgentSystem<T>	getSystem()
void	kickOff(Section... sections) Works like the AgentBasedModel#run(Section) function but only when time = kickoff as defined in ModelSettings
void	lastStep(Section... sections) Works like the AgentBasedModel#run(Section) function but only when time = end as defined in ModelSettings
<A extends Agent<T>> Group<A>	loadGroup(java.lang.Class<A> clazz, Source source) loadGroup(Class, Source, SerializableConsumer) without a data injector so no initial function is run for agents
<A extends Agent<T>> Group<A>	loadGroup(java.lang.Class<A> agentClass, Source source, SerializableConsumer<A> dataInjector) Create a Group of agents using data loaded from a Source.
void	registerAgentType(java.lang.Class<? extends Vertex<T>> type) Deprecated.
void	registerAgentTypes(java.lang.Class<? extends Vertex<T>>... types)
void	registerLinkTypes(java.lang.Class<? extends Link>... types)
void	registerMessageTypes(java.lang.Class<? extends Message>... types)
void	registerSchemas(ModelContext dataContext)
void	run(Section... sections)
<A extends Agent<T>> AgentSelection<A>	select(java.lang.Class<A> agentType)
void	setup() An optional lifecycle point at which to take configured initial parameters and initialise required internal state.
boolean	shouldEmitData()
<A extends Agent<T>> AgentStatistics<A>	stats(java.lang.Class<A> agentType)
void	step() Required lifecycle method for implementing the calculation of a model.
void	writeToLog(ALCat inType, java.lang.String value)
void	writeToLog(java.lang.String value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface simudyne.core.Model

dispose, init

Field Detail

system

public final AgentSystem<T extends GlobalState> system

Constructor Detail

AgentBasedModel

public AgentBasedModel()

Method Detail

enableAtomicLogging

public void enableAtomicLogging()

writeToLog

public void writeToLog(ALCat inType,
                       java.lang.String value)

Specified by:

writeToLog in interface Model

writeToLog

public void writeToLog(java.lang.String value)

generateGroup

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

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

generateGroup

public <A extends Agent<T>> Group<A> generateGroup(boolean logger,
                                                   java.lang.Class<A> agentClass,
                                                   long size)

generateGroup

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

Create a Group of agents.

Type Parameters:

A - 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

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

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

loadGroup

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

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

Type Parameters:

A - 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

getGlobals

public T getGlobals()

Returns:

Globally available object of type T.

registerAgentType

@Deprecated
public final void registerAgentType(java.lang.Class<? extends Vertex<T>> type)

Deprecated.

This method is likely to be removed in a future release, use AgentBasedModel#registerAgentTypes instead.

Parameters:

type -

registerAgentTypes

@SafeVarargs
public final void registerAgentTypes(java.lang.Class<? extends Vertex<T>>... types)

registerMessageTypes

@SafeVarargs
public final void registerMessageTypes(java.lang.Class<? extends Message>... types)

registerLinkTypes

@SafeVarargs
public final void registerLinkTypes(java.lang.Class<? extends Link>... types)

select

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

stats

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

createLongAccumulator

public 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

public 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

createLongAccumulator

public LongAccumulator createLongAccumulator(java.lang.String name)

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

createDoubleAccumulator

public DoubleAccumulator createDoubleAccumulator(java.lang.String name)

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

getLongAccumulator

public LongAccumulator getLongAccumulator(java.lang.String name)

getDoubleAccumulator

public DoubleAccumulator getDoubleAccumulator(java.lang.String name)

setup

public void setup()

Description copied from interface: Model

An optional lifecycle point at which to take configured initial parameters and initialise required internal state.

Specified by:

setup in interface Model

step

public void step()

Description copied from interface: Model

Required lifecycle method for implementing the calculation of a model.

step will be called once or more times, with the external user or simudyne.core.exec.harness able to read outputs, change inputs, etc. in-between calls. Each step represents the moving forward in time, but the explicit notion of progress is left as specific to the implementing model.

Specified by:

step in interface Model

done

public void done()

Specified by:

done in interface Model

finish

public void finish()

run

public void run(Section... sections)

firstStep

public void firstStep(Section... sections)

Works like the AgentBasedModel#run(Section) function but only when time = 0

Parameters:

sections -

lastStep

public void lastStep(Section... sections)

Works like the AgentBasedModel#run(Section) function but only when time = end as defined in ModelSettings

Parameters:

sections -

kickOff

public void kickOff(Section... sections)

Works like the AgentBasedModel#run(Section) function but only when time = kickoff as defined in ModelSettings

Parameters:

sections -

getContext

public ModelContext getContext()

getConfig

public Configuration getConfig()

emitData

public void emitData(ModelContext context,
                     ModelExecutionPhase phase)

Specified by:

emitData in interface Value

Specified by:

emitData in interface Model

shouldEmitData

public boolean shouldEmitData()

Specified by:

shouldEmitData in interface Model

registerSchemas

public void registerSchemas(ModelContext dataContext)

Specified by:

registerSchemas in interface Value

Specified by:

registerSchemas in interface Model

getSystem

public AgentSystem<T> getSystem()