simudyne.core.graph.local

Class LocalEnvironment<S extends simudyne.core.graph.BaseGlobalState>

java.lang.Object

simudyne.core.graph.local.LocalEnvironment<S>

All Implemented Interfaces:

Environment<S>

public class LocalEnvironment<S extends simudyne.core.graph.BaseGlobalState>
extends java.lang.Object
implements Environment<S>

Constructor Summary

Constructors

Constructor and Description
LocalEnvironment(simudyne.core.graph.local.LocalGraph<S> system, int phaseCount, simudyne.core.graph.local.VertexBlock<S> block, ModelContext context, boolean sortInboxes, java.util.Map<java.lang.String,LocalLongAccumulatorView> agentLongAccumulators, java.util.Map<java.lang.String,LocalDoubleAccumulatorView> agentDoubleAccumulators)

Method Summary

Modifier and Type	Method and Description
void	deferMessages(java.util.List<Message> messages) Postpone messages to be handled later.
void	deferTask(java.util.function.Consumer<Vertex<? extends simudyne.core.graph.BaseGlobalState>> dataInjector) Postpone the application of some Consumer until the end of the phase.
void	deliverMessage(Message message)
ModelContext	getContext()
DoubleAccumulatorView	getDoubleAccumulator(java.lang.String name) Gets a previously created Double Accumulator
S	getGlobals() Get a global value that the system has broadcast to all vertices.
LongAccumulatorView	getLongAccumulator(java.lang.String name) Gets a previously created Long Accumulator
java.util.Iterator<Message>	getMessageIterator()
<T extends Message> java.util.List<T>	getMessagesOfType(java.lang.Class<T> clazz)
long	getMessageTag()
int	getPhaseCount()
simudyne.core.graph.GraphConfiguration	getSystemConfig()
Model	getSystemModel()
void	processVertex(long id, Vertex<S> vertex, java.util.ArrayList<Message> inbox, java.util.Queue<java.lang.Long> stoppedVertices)
<M extends Message> Messaging<M>	send(java.lang.Class<M> clazz, java.util.function.Consumer<M> dataInjector) Create a Messaging object for sending messages.
void	setMessageTag(long tag) Set the value of the message tag which will be embedded in each message sent by this Environment.
<T extends Vertex<S>> simudyne.core.graph.PreSpawnedAgent<T>	spawn(java.lang.Class<T> vertexType, SerializableConsumer<T> dataInjector) Creates a new agent.
<V extends Vertex<S>> simudyne.core.graph.PreSpawnedAgent<V>	spawn(java.lang.Class<V> vertexType)
void	stop() Allow an vertex to stop it self.

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.Environment

deferMessages, getMessageOfType, hasMessageOfType, hasMessageOfType, hasMessagesOfType, hasMessagesOfType, send, send, send, send, send, send, send, sendOrdered, sendOrdered, sendOrdered, sendOrdered, sendOrdered, sendOrdered, sendOrdered, sendOrdered

Constructor Detail

LocalEnvironment

public LocalEnvironment(simudyne.core.graph.local.LocalGraph<S> system,
                        int phaseCount,
                        simudyne.core.graph.local.VertexBlock<S> block,
                        ModelContext context,
                        boolean sortInboxes,
                        java.util.Map<java.lang.String,LocalLongAccumulatorView> agentLongAccumulators,
                        java.util.Map<java.lang.String,LocalDoubleAccumulatorView> agentDoubleAccumulators)

Method Detail

getSystemModel

public Model getSystemModel()

getSystemConfig

public simudyne.core.graph.GraphConfiguration getSystemConfig()

setMessageTag

public void setMessageTag(long tag)

Description copied from interface: Environment

Set the value of the message tag which will be embedded in each message sent by this Environment.

Specified by:

setMessageTag in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

processVertex

public void processVertex(long id,
                          Vertex<S> vertex,
                          java.util.ArrayList<Message> inbox,
                          java.util.Queue<java.lang.Long> stoppedVertices)

getPhaseCount

public int getPhaseCount()

Specified by:

getPhaseCount in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

Returns:

The number of message phases that have been previously executed.

getGlobals

public S getGlobals()

Description copied from interface: Environment

Get a global value that the system has broadcast to all vertices.

Specified by:

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

Returns:

The global state object.

send

public <M extends Message> Messaging<M> send(java.lang.Class<M> clazz,
                                             java.util.function.Consumer<M> dataInjector)

Description copied from interface: Environment

Create a Messaging object for sending messages.

Specified by:

send in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

clazz - Class of message to send. Must be a message class extending Message.

dataInjector - Function run when each message is created which can be used to set its values.

getMessageIterator

public java.util.Iterator<Message> getMessageIterator()

Specified by:

getMessageIterator in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

getMessagesOfType

public <T extends Message> java.util.List<T> getMessagesOfType(java.lang.Class<T> clazz)

Specified by:

getMessagesOfType in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

getLongAccumulator

public LongAccumulatorView getLongAccumulator(java.lang.String name)

Description copied from interface: Environment

Gets a previously created Long Accumulator

Specified by:

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

Parameters:

name - name of the accumulator

Returns:

the existing accumulator

getDoubleAccumulator

public DoubleAccumulatorView getDoubleAccumulator(java.lang.String name)

Description copied from interface: Environment

Gets a previously created Double Accumulator

Specified by:

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

Parameters:

name - name of the accumulator

Returns:

the existing accumulator

stop

public void stop()

Description copied from interface: Environment

Allow an vertex to stop it self.

Specified by:

stop in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

deferMessages

public void deferMessages(java.util.List<Message> messages)

Description copied from interface: Environment

Postpone messages to be handled later.

Specified by:

deferMessages in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

messages - The list of messages to be deferred.

deliverMessage

public void deliverMessage(Message message)

Specified by:

deliverMessage in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

getMessageTag

public long getMessageTag()

Specified by:

getMessageTag in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

deferTask

public void deferTask(java.util.function.Consumer<Vertex<? extends simudyne.core.graph.BaseGlobalState>> dataInjector)

Description copied from interface: Environment

Postpone the application of some Consumer until the end of the phase.

Specified by:

deferTask in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

Parameters:

dataInjector - The Consumer that will be applied on the Vertex at the end of the phase.

spawn

public <T extends Vertex<S>> simudyne.core.graph.PreSpawnedAgent<T> spawn(java.lang.Class<T> vertexType,
                                                                          SerializableConsumer<T> dataInjector)

Description copied from interface: Environment

Creates a new agent.

Specified by:

spawn in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

Returns:

SpawnedVertex which can be used to send messages or create links to this new spawned agent.

spawn

public <V extends Vertex<S>> simudyne.core.graph.PreSpawnedAgent<V> spawn(java.lang.Class<V> vertexType)

Specified by:

spawn in interface Environment<S extends simudyne.core.graph.BaseGlobalState>

See Also:

Environment.spawn(Class, SerializableConsumer)

getContext

public ModelContext getContext()

Specified by:

getContext in interface Environment<S extends simudyne.core.graph.BaseGlobalState>