simudyne.core.abm

Class Agent<S extends GlobalState>

java.lang.Object

simudyne.core.graph.Vertex<S>

simudyne.core.abm.Agent<S>

All Implemented Interfaces:

Environment<S>, LinksApi

public class Agent<S extends GlobalState>
extends Vertex<S>
implements Environment<S>

Constructor Summary

Constructors

Constructor and Description
Agent()

Method Summary

Modifier and Type	Method and Description
void	deferMessages(java.util.List<Message> messages) Postpone messages to be handled later.
void	deliverMessage(Message message)
DoubleAccumulator	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.
long	getGroupPosition()
LongAccumulator	getLongAccumulator(java.lang.String name) Gets a previously created Long Accumulator
java.util.Iterator<? extends Message>	getMessageIterator()
<T extends Message> java.util.List<T>	getMessagesOfType(java.lang.Class<T> clazz)
long	getMessageTag()
int	getPhaseCount()
void	init() Initialise the Agent.
<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.
void	step(Environment<S> env)
void	stop() Allow an vertex to stop it self.

Methods inherited from class simudyne.core.graph.Vertex

addLink, addLink, addLinks, addLinks, dispose, getID, getLinks, getLinks, getLinksTo, getLinksTo, getPrng, hasLinks, hasLinks, hasLinksTo, hasLinksTo, removeLinks, removeLinks, removeLinksTo, removeLinksTo

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

Constructor Detail

Agent

public Agent()

Method Detail

init

public void init()

Initialise the Agent. This method is called just after the Agent is constructed, allowing the state of the agent to be updated. At this point this is called, the agent will have access to globals, but will be run before the group data injector, and before any links from connectors are created.

step

public void step(Environment<S> env)

Specified by:

step in class Vertex<S extends GlobalState>

getPhaseCount

public int getPhaseCount()

Specified by:

getPhaseCount in interface Environment<S extends GlobalState>

Returns:

The number of message phases that have been previously executed.

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

getMessageTag

public long getMessageTag()

Specified by:

getMessageTag in interface Environment<S extends GlobalState>

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

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

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<? extends Message> getMessageIterator()

Specified by:

getMessageIterator in interface Environment<S extends GlobalState>

getMessagesOfType

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

Specified by:

getMessagesOfType in interface Environment<S extends GlobalState>

getLongAccumulator

public LongAccumulator getLongAccumulator(java.lang.String name)

Description copied from interface: Environment

Gets a previously created Long Accumulator

Specified by:

getLongAccumulator in interface Environment<S extends GlobalState>

Parameters:

name - name of the accumulator

Returns:

the existing accumulator

getDoubleAccumulator

public DoubleAccumulator getDoubleAccumulator(java.lang.String name)

Description copied from interface: Environment

Gets a previously created Double Accumulator

Specified by:

getDoubleAccumulator in interface Environment<S extends GlobalState>

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

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

Parameters:

messages - The list of messages to be deferred.

deliverMessage

public void deliverMessage(Message message)

Specified by:

deliverMessage in interface Environment<S extends GlobalState>

getGroupPosition

public long getGroupPosition()