simudyne.core.graph

Class BaseGraph<S extends simudyne.core.graph.BaseGlobalState,LAcc extends LongAccumulator,DAcc extends DoubleAccumulator>

java.lang.Object

simudyne.core.graph.BaseGraph<S,LAcc,DAcc>

All Implemented Interfaces:

java.io.Serializable, Value, Graph<S>, JSONValue

public abstract class BaseGraph<S extends simudyne.core.graph.BaseGlobalState,LAcc extends LongAccumulator,DAcc extends DoubleAccumulator>
extends java.lang.Object
implements Graph<S>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	config
protected ModelContext	context
java.util.concurrent.ConcurrentHashMap<java.lang.String,DAcc>	doubleAccumulators
protected simudyne.core.FeatureFlags	featureFlags
protected simudyne.core.graph.GraphConfiguration	graphConfig
protected boolean	isSetup
protected java.util.Set<java.lang.Class<? extends Link>>	linkClasses
protected static org.slf4j.Logger	logger
java.util.concurrent.ConcurrentHashMap<java.lang.String,LAcc>	longAccumulators
protected java.util.Set<java.lang.Class<? extends Vertex<S>>>	vertexClasses

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseGraph(ModelContext context, simudyne.core.graph.GraphConfiguration graphConfig, S globalState)

Method Summary

Modifier and Type	Method and Description
<T extends Vertex<S>> void	addVertices(java.lang.Class<T> vertexType, long vertexCount) Add a number of agents to the system.
<T extends Vertex<S>> void	addVertices(java.lang.Class<T> vertexType, long vertexCount, SerializableBiConsumer<InitContext,T> dataInjector) Add a number of agents to the system.
protected abstract <T extends Vertex<S>> void	addVerticesImpl(java.lang.Class<T> vertexType, long vertexCount, SerializableBiConsumer<InitContext,T> dataInjector)
void	beginStep() reset all the accumulator that haven't been flagged as persistent
DoubleAccumulator	createDoubleAccumulator(java.lang.String name, java.lang.String displayName) Create a new DoubleAccumulator on the AgentSystem.
DoubleAccumulator	createDoubleAccumulator(java.lang.String name, java.lang.String displayName, double initialValue) Create a new DoubleAccumulator on the AgentSystem.
protected abstract DoubleAccumulator	createDoubleAccumulatorImpl(java.lang.String name, java.lang.String displayName)
protected abstract DoubleAccumulator	createDoubleAccumulatorImpl(java.lang.String name, java.lang.String displayName, double initialValue)
LongAccumulator	createLongAccumulator(java.lang.String name, java.lang.String displayName) Create a new LongAccumulator on the AgentSystem.
LongAccumulator	createLongAccumulator(java.lang.String name, java.lang.String displayName, long initialValue) Create a new LongAccumulator on the AgentSystem.
protected abstract LongAccumulator	createLongAccumulatorImpl(java.lang.String name, java.lang.String displayName)
protected abstract LongAccumulator	createLongAccumulatorImpl(java.lang.String name, java.lang.String displayName, long initialValue)
simudyne.core.graph.GraphConfiguration	getConfig()
DoubleAccumulator	getDoubleAccumulator(java.lang.String name) Get a previously created DoubleAccumulator
protected abstract DoubleAccumulator	getDoubleAccumulatorImpl(java.lang.String name)
java.util.Map<java.lang.String,DoubleAccumulator>	getDoubleAccumulators() Get all previously created DoubleAccumulator as a read only map.
S	getGlobals() Get the value of the global state that can be read globally by agents.
LongAccumulator	getLongAccumulator(java.lang.String name) Get a previously created LongAccumulator
protected abstract LongAccumulator	getLongAccumulatorImpl(java.lang.String name)
java.util.Map<java.lang.String,LongAccumulator>	getLongAccumulators() Get all previously created LongAccumulator as a read only map.
boolean	isSetup()
void	registerLinkTypes(java.lang.Class<? extends Link>... types) Register link types with the system for serialisation.
void	registerMessageTypes(java.lang.Class<? extends Message>... types) Register message types with the system for serialisation.
void	registerSchemas(ModelContext context)
void	registerVertexTypes(java.lang.Class<? extends Vertex<S>>... types) Register agent types with the system for serialisation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface simudyne.core.graph.Graph

create, getNextVertexID, hasProcessedMessages, selectVertices, setup, step

Methods inherited from interface simudyne.core.JSONValue

getSchema, getValues, receiveJSON

Methods inherited from interface simudyne.core.channel.Value

emitData

Field Detail

logger

protected static final org.slf4j.Logger logger

vertexClasses

protected final java.util.Set<java.lang.Class<? extends Vertex<S extends simudyne.core.graph.BaseGlobalState>>> vertexClasses

linkClasses

protected final java.util.Set<java.lang.Class<? extends Link>> linkClasses

longAccumulators

public final java.util.concurrent.ConcurrentHashMap<java.lang.String,LAcc extends LongAccumulator> longAccumulators

doubleAccumulators

public final java.util.concurrent.ConcurrentHashMap<java.lang.String,DAcc extends DoubleAccumulator> doubleAccumulators

featureFlags

protected final simudyne.core.FeatureFlags featureFlags

config

protected final Configuration config

graphConfig

protected final simudyne.core.graph.GraphConfiguration graphConfig

context

protected final ModelContext context

isSetup

protected boolean isSetup

Constructor Detail

BaseGraph

protected BaseGraph(ModelContext context,
                    simudyne.core.graph.GraphConfiguration graphConfig,
                    S globalState)

Method Detail

registerLinkTypes

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

Description copied from interface: Graph

Register link types with the system for serialisation.

Specified by:

registerLinkTypes in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

registerMessageTypes

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

Description copied from interface: Graph

Register message types with the system for serialisation.

Specified by:

registerMessageTypes in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

registerVertexTypes

public final void registerVertexTypes(java.lang.Class<? extends Vertex<S>>... types)

Description copied from interface: Graph

Register agent types with the system for serialisation.

Specified by:

registerVertexTypes in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

types - Agent classes to register. Must implement Agent.

getGlobals

public final S getGlobals()

Description copied from interface: Graph

Get the value of the global state that can be read globally by agents.

Specified by:

getGlobals in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Returns:

The global state object

isSetup

public boolean isSetup()

Specified by:

isSetup in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Returns:

if the system has been initialised or not

getConfig

public simudyne.core.graph.GraphConfiguration getConfig()

addVertices

public final <T extends Vertex<S>> void addVertices(java.lang.Class<T> vertexType,
                                                    long vertexCount,
                                                    SerializableBiConsumer<InitContext,T> dataInjector)

Description copied from interface: Graph

Add a number of agents to the system.

Specified by:

addVertices in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

addVerticesImpl

protected abstract <T extends Vertex<S>> void addVerticesImpl(java.lang.Class<T> vertexType,
                                                              long vertexCount,
                                                              SerializableBiConsumer<InitContext,T> dataInjector)

addVertices

public final <T extends Vertex<S>> void addVertices(java.lang.Class<T> vertexType,
                                                    long vertexCount)

Description copied from interface: Graph

Add a number of agents to the system.

Specified by:

addVertices in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

createLongAccumulator

public final LongAccumulator createLongAccumulator(java.lang.String name,
                                                   java.lang.String displayName)

Description copied from interface: Graph

Create a new LongAccumulator on the AgentSystem.

Specified by:

createLongAccumulator in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

name - The accumulator name

displayName - The name shown by the console

Returns:

The created accumulator instance

createLongAccumulatorImpl

protected abstract LongAccumulator createLongAccumulatorImpl(java.lang.String name,
                                                             java.lang.String displayName)

createLongAccumulator

public final LongAccumulator createLongAccumulator(java.lang.String name,
                                                   java.lang.String displayName,
                                                   long initialValue)

Description copied from interface: Graph

Create a new LongAccumulator on the AgentSystem.

Specified by:

createLongAccumulator in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

name - The accumulator name

displayName - The name shown by the console

initialValue - For populating with a default value at initial time step

Returns:

The created accumulator instance

createLongAccumulatorImpl

protected abstract LongAccumulator createLongAccumulatorImpl(java.lang.String name,
                                                             java.lang.String displayName,
                                                             long initialValue)

getLongAccumulator

public final LongAccumulator getLongAccumulator(java.lang.String name)

Description copied from interface: Graph

Get a previously created LongAccumulator

Specified by:

getLongAccumulator in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

name - The accumulator name

Returns:

The accumulator instance

getLongAccumulatorImpl

protected abstract LongAccumulator getLongAccumulatorImpl(java.lang.String name)

getLongAccumulators

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

Description copied from interface: Graph

Get all previously created LongAccumulator as a read only map. Attempting to add accumulators to this map will not work, and the accumulators will not be available on the AgentSystem.

Specified by:

getLongAccumulators in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Returns:

(Read only) Map of accumulator names with their instance as a JSONValue object

createDoubleAccumulator

public final DoubleAccumulator createDoubleAccumulator(java.lang.String name,
                                                       java.lang.String displayName)

Description copied from interface: Graph

Create a new DoubleAccumulator on the AgentSystem.

Specified by:

createDoubleAccumulator in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

name - The accumulator name

displayName - The name shown by the console

Returns:

The created accumulator instance

createDoubleAccumulatorImpl

protected abstract DoubleAccumulator createDoubleAccumulatorImpl(java.lang.String name,
                                                                 java.lang.String displayName)

createDoubleAccumulator

public final DoubleAccumulator createDoubleAccumulator(java.lang.String name,
                                                       java.lang.String displayName,
                                                       double initialValue)

Description copied from interface: Graph

Create a new DoubleAccumulator on the AgentSystem.

Specified by:

createDoubleAccumulator in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

name - The accumulator name

displayName - The name shown by the console

initialValue - For populating with a default value at initial time step

Returns:

The created accumulator instance

createDoubleAccumulatorImpl

protected abstract DoubleAccumulator createDoubleAccumulatorImpl(java.lang.String name,
                                                                 java.lang.String displayName,
                                                                 double initialValue)

getDoubleAccumulator

public final DoubleAccumulator getDoubleAccumulator(java.lang.String name)

Description copied from interface: Graph

Get a previously created DoubleAccumulator

Specified by:

getDoubleAccumulator in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

name - The accumulator name

Returns:

The accumulator instance

getDoubleAccumulatorImpl

protected abstract DoubleAccumulator getDoubleAccumulatorImpl(java.lang.String name)

getDoubleAccumulators

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

Description copied from interface: Graph

Get all previously created DoubleAccumulator as a read only map. Attempting to add accumulators to this map will not work, and the accumulators will not be available on the AgentSystem.

Specified by:

getDoubleAccumulators in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

Returns:

(Read only) Map of accumulator names with their instance as a JSONValue object

beginStep

public void beginStep()

Description copied from interface: Graph

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

Specified by:

beginStep in interface Graph<S extends simudyne.core.graph.BaseGlobalState>

registerSchemas

public final void registerSchemas(ModelContext context)

Specified by:

registerSchemas in interface Value