simudyne.core.graph

Interface Environment<BGS extends simudyne.core.graph.BaseGlobalState>

All Known Implementing Classes:

Agent, LocalEnvironment

public interface Environment<BGS extends simudyne.core.graph.BaseGlobalState>

Method Summary

Modifier and Type	Method and Description
default <T extends Message> void	deferMessages(java.lang.Class<T> clazz) Postpone messages of the given type to be handled later.
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)
AgentContext	getContext()
DoubleAccumulatorView	getDoubleAccumulator(java.lang.String name) Gets a previously created Double Accumulator
BGS	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<? extends Message>	getMessageIterator()
default <T extends Message> T	getMessageOfType(java.lang.Class<T> clazz)
<T extends Message> java.util.List<T>	getMessagesOfType(java.lang.Class<T> clazz)
long	getMessageTag()
int	getPhaseCount()
default <T extends Message> boolean	hasMessageOfType(java.lang.Class<T> clazz)
default <T extends Message> boolean	hasMessageOfType(java.lang.Class<T> clazz, java.util.function.Consumer<T> handler) Query the vertex inbox for a message of the given type.
default <T extends Message> boolean	hasMessagesOfType(java.lang.Class<T> clazz)
default <T extends Message> boolean	hasMessagesOfType(java.lang.Class<T> clazz, java.util.function.Consumer<java.util.List<T>> handler) Query the vertex inbox for messages of the given type.
default <M extends Message> Messaging<M>	send(java.lang.Class<M> clazz) send(Class, Consumer) without a data injector so no initial function is run for messages.
default <M extends Message.Boolean> Messaging<M>	send(java.lang.Class<M> clazz, boolean messageBody) Create a Messaging object for sending messages with single boolean field.
<M extends Message> Messaging<M>	send(java.lang.Class<M> clazz, java.util.function.Consumer<M> dataInjector) Create a Messaging object for sending messages.
default <M extends Message.Double> Messaging<M>	send(java.lang.Class<M> clazz, double messageBody) Create a Messaging object for sending messages with single double field.
default <M extends Message.Float> Messaging<M>	send(java.lang.Class<M> clazz, float messageBody) Create a Messaging object for sending messages with single float field.
default <M extends Message.Integer> Messaging<M>	send(java.lang.Class<M> clazz, int messageBody) Create a Messaging object for sending messages with single int field.
default <M extends Message.Long> Messaging<M>	send(java.lang.Class<M> clazz, long messageBody) Create a Messaging object for sending messages with single long field.
default <M extends Message.Object<T>,T> Messaging<M>	send(java.lang.Class<M> clazz, T messageBody) Create a Messaging object for sending messages with single field.
default <M extends OrderedMessage> Messaging<M>	sendOrdered(java.lang.Class<M> clazz)
default <M extends OrderedMessage.Boolean> Messaging<M>	sendOrdered(java.lang.Class<M> clazz, boolean messageBody)
default <M extends OrderedMessage> Messaging<M>	sendOrdered(java.lang.Class<M> clazz, java.util.function.Consumer<M> dataInjector)
default <M extends OrderedMessage.Double> Messaging<M>	sendOrdered(java.lang.Class<M> clazz, double messageBody)
default <M extends OrderedMessage.Float> Messaging<M>	sendOrdered(java.lang.Class<M> clazz, float messageBody)
default <M extends OrderedMessage.Integer> Messaging<M>	sendOrdered(java.lang.Class<M> clazz, int messageBody)
default <M extends OrderedMessage.Long> Messaging<M>	sendOrdered(java.lang.Class<M> clazz, long messageBody)
default <M extends OrderedMessage.Object<T>,T> Messaging<M>	sendOrdered(java.lang.Class<M> clazz, T messageBody)
void	setMessageTag(long tag) Set the value of the message tag which will be embedded in each message sent by this Environment.
<V extends Vertex<BGS>> simudyne.core.graph.PreSpawnedAgent<?>	spawn(java.lang.Class<V> vertexType)
<V extends Vertex<BGS>> simudyne.core.graph.PreSpawnedAgent<?>	spawn(java.lang.Class<V> vertexType, SerializableConsumer<V> dataInjector) Creates a new agent.
void	stop() Allow an vertex to stop it self.

Method Detail

getPhaseCount

int getPhaseCount()

Returns:

The number of message phases that have been previously executed.

setMessageTag

void setMessageTag(long tag)

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

getGlobals

BGS getGlobals()

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

Returns:

The global state object.

send

default <M extends Message> Messaging<M> send(java.lang.Class<M> clazz)

send(Class, Consumer) without a data injector so no initial function is run for messages.

send

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

Create a Messaging object for sending messages.

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.

send

default <M extends Message.Boolean> Messaging<M> send(java.lang.Class<M> clazz,
                                                      boolean messageBody)

Create a Messaging object for sending messages with single boolean field.

Parameters:

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

messageBody - Value for message body.

send

default <M extends Message.Float> Messaging<M> send(java.lang.Class<M> clazz,
                                                    float messageBody)

Create a Messaging object for sending messages with single float field.

Parameters:

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

messageBody - Value for message body.

send

default <M extends Message.Long> Messaging<M> send(java.lang.Class<M> clazz,
                                                   long messageBody)

Create a Messaging object for sending messages with single long field.

Parameters:

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

messageBody - Value for message body.

send

default <M extends Message.Double> Messaging<M> send(java.lang.Class<M> clazz,
                                                     double messageBody)

Create a Messaging object for sending messages with single double field.

Parameters:

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

messageBody - Value for message body.

send

default <M extends Message.Integer> Messaging<M> send(java.lang.Class<M> clazz,
                                                      int messageBody)

Create a Messaging object for sending messages with single int field.

Parameters:

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

messageBody - Value for message body.

send

default <M extends Message.Object<T>,T> Messaging<M> send(java.lang.Class<M> clazz,
                                                          T messageBody)

Create a Messaging object for sending messages with single field.

Parameters:

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

messageBody - Value for message body.

sendOrdered

default <M extends OrderedMessage> Messaging<M> sendOrdered(java.lang.Class<M> clazz,
                                                            java.util.function.Consumer<M> dataInjector)

sendOrdered

default <M extends OrderedMessage> Messaging<M> sendOrdered(java.lang.Class<M> clazz)

sendOrdered

default <M extends OrderedMessage.Boolean> Messaging<M> sendOrdered(java.lang.Class<M> clazz,
                                                                    boolean messageBody)

sendOrdered

default <M extends OrderedMessage.Float> Messaging<M> sendOrdered(java.lang.Class<M> clazz,
                                                                  float messageBody)

sendOrdered

default <M extends OrderedMessage.Long> Messaging<M> sendOrdered(java.lang.Class<M> clazz,
                                                                 long messageBody)

sendOrdered

default <M extends OrderedMessage.Double> Messaging<M> sendOrdered(java.lang.Class<M> clazz,
                                                                   double messageBody)

sendOrdered

default <M extends OrderedMessage.Integer> Messaging<M> sendOrdered(java.lang.Class<M> clazz,
                                                                    int messageBody)

sendOrdered

default <M extends OrderedMessage.Object<T>,T> Messaging<M> sendOrdered(java.lang.Class<M> clazz,
                                                                        T messageBody)

hasMessageOfType

default <T extends Message> boolean hasMessageOfType(java.lang.Class<T> clazz,
                                                     java.util.function.Consumer<T> handler)

Query the vertex inbox for a message of the given type. Can also provide a handler function which will be called with the message (if present).

Parameters:

clazz - The message type to query for.

handler - The handler called when a message of that type is present.

Returns:

Whether any message of that type exists.

hasMessageOfType

default <T extends Message> boolean hasMessageOfType(java.lang.Class<T> clazz)

getMessageOfType

default <T extends Message> T getMessageOfType(java.lang.Class<T> clazz)

hasMessagesOfType

default <T extends Message> boolean hasMessagesOfType(java.lang.Class<T> clazz,
                                                      java.util.function.Consumer<java.util.List<T>> handler)

Query the vertex inbox for messages of the given type. Can also provide a handler function which will be called with the messages (if any are present).

Parameters:

clazz - The message type to query for.

handler - The handler called when messages of that type are present.

Returns:

Whether any message of that type exists.

hasMessagesOfType

default <T extends Message> boolean hasMessagesOfType(java.lang.Class<T> clazz)

getMessageIterator

java.util.Iterator<? extends Message> getMessageIterator()

getMessagesOfType

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

getLongAccumulator

LongAccumulatorView getLongAccumulator(java.lang.String name)

Gets a previously created Long Accumulator

Parameters:

name - name of the accumulator

Returns:

the existing accumulator

Throws:

java.lang.RuntimeException - if no accumulator of this name exists

getDoubleAccumulator

DoubleAccumulatorView getDoubleAccumulator(java.lang.String name)

Gets a previously created Double Accumulator

Parameters:

name - name of the accumulator

Returns:

the existing accumulator

Throws:

java.lang.RuntimeException - if no accumulator of this name exists

stop

void stop()

Allow an vertex to stop it self.

deferMessages

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

Postpone messages to be handled later.

Parameters:

messages - The list of messages to be deferred.

deferMessages

default <T extends Message> void deferMessages(java.lang.Class<T> clazz)

Postpone messages of the given type to be handled later.

Parameters:

clazz - The message type to query for.

deliverMessage

void deliverMessage(Message message)

getMessageTag

long getMessageTag()

deferTask

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.

Parameters:

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

spawn

<V extends Vertex<BGS>> simudyne.core.graph.PreSpawnedAgent<?> spawn(java.lang.Class<V> vertexType,
                                                                     SerializableConsumer<V> dataInjector)

Creates a new agent.

Returns:

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

spawn

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

See Also:

spawn(Class, SerializableConsumer)

getContext

AgentContext getContext()