simudyne.core.graph

Class Vertex<BGS extends simudyne.core.graph.BaseGlobalState>

java.lang.Object

simudyne.core.graph.Vertex<BGS>

Direct Known Subclasses:

Agent

public abstract class Vertex<BGS extends simudyne.core.graph.BaseGlobalState>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Vertex()

Method Summary

Modifier and Type	Method and Description
<L extends Link> L	addLink(long vertexID, java.lang.Class<L> clazz) addLink(long, Class, Consumer) without a data injector so no initial function is run for links.
<L extends Link> L	addLink(long vertexID, java.lang.Class<L> clazz, java.util.function.Consumer<L> dataInjector) Create a new link from this vertex to the target vertexID, with the given associated data.
<L extends Link> L	addLink(simudyne.core.graph.PreSpawnedAgent<?> preSpawnedAgent, java.lang.Class<L> clazz) addLink(PreSpawnedAgent, Class, Consumer) without a data injector so no initial function is run for links.
<L extends Link> L	addLink(simudyne.core.graph.PreSpawnedAgent<?> preSpawnedAgent, java.lang.Class<L> clazz, java.util.function.Consumer<L> dataInjector) Create a new link from this vertex to the target vertexID, with the given associated data.
<L extends Link> java.util.List<L>	addLinks(java.util.Collection<java.lang.Long> vertexIDs, java.lang.Class<L> clazz) addLinks(Collection, Class) without a data injector so no initial function is run for links.
<L extends Link> java.util.List<L>	addLinks(java.util.Collection<java.lang.Long> vertexIDs, java.lang.Class<L> clazz, java.util.function.Consumer<L> dataInjector) Create a new link from this vertex to a group of target vertexIDs, with the given associated data.
void	dispose()
protected Environment<BGS>	getEnvironment()
long	getID()
java.util.List<? extends Link>	getLinks() Get all of the vertex's links.
<L extends Link> FilteredLinks<L>	getLinks(java.lang.Class<L> clazz) Get the vertex's links of the given type.
FilteredLinks<? extends Link>	getLinksTo(long targetID) Get the vertex's links to the given target ID.
<L extends Link> FilteredLinks<L>	getLinksTo(long targetID, java.lang.Class<L> clazz) Get the vertex's links of specified class to the given target ID.
SeededRandom	getPrng()
boolean	hasLinks()
boolean	hasLinks(java.lang.Class<? extends Link> clazz)
boolean	hasLinksTo(long targetID)
boolean	hasLinksTo(long targetID, java.lang.Class<? extends Link> clazz)
void	removeLinks() Removes all the vertex's links.
void	removeLinks(java.lang.Class<? extends Link> clazz) Removes all vertex's links of a given type.
void	removeLinksTo(long targetID) Removes the vertex's links to a certain target ID.
void	removeLinksTo(long targetID, java.lang.Class<? extends Link> clazz) Removes the vertex's links to a certain targetID of a given type.
protected void	setEnvironment(Environment<BGS> env)
abstract void	step(Environment<BGS> environment)

Methods inherited from class java.lang.Object

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

Constructor Detail

Vertex

public Vertex()

Method Detail

step

public abstract void step(Environment<BGS> environment)

getID

public long getID()

Returns:

The ID of the current agent.

getPrng

public SeededRandom getPrng()

Returns:

a seeded pseudo-random number generator *

getLinks

public java.util.List<? extends Link> getLinks()

Get all of the vertex's links.

Note that without a specific link class, data for the link will not be accessible.

Returns:

A list of vertex ids.

getLinks

public <L extends Link> FilteredLinks<L> getLinks(java.lang.Class<L> clazz)

Get the vertex's links of the given type.

Parameters:

clazz - The link data class.

Returns:

List of Links of the given class.

getLinksTo

public FilteredLinks<? extends Link> getLinksTo(long targetID)

Get the vertex's links to the given target ID.

Parameters:

targetID - The target vertex ID.

Returns:

List of Links to the given target

getLinksTo

public <L extends Link> FilteredLinks<L> getLinksTo(long targetID,
                                                    java.lang.Class<L> clazz)

Get the vertex's links of specified class to the given target ID.

Parameters:

targetID - The target vertex ID.

clazz - The link data class

Returns:

List of Links to the given target

hasLinks

public boolean hasLinks()

Returns:

If the vertex has any Links to other vertices.

hasLinks

public boolean hasLinks(java.lang.Class<? extends Link> clazz)

Parameters:

clazz - The link data class

Returns:

If the vertex has any Links of specified class to other vertices.

hasLinksTo

public boolean hasLinksTo(long targetID)

Parameters:

targetID - The target vertex ID.

Returns:

If the vertex has any Links to vertex with given targetID.

hasLinksTo

public boolean hasLinksTo(long targetID,
                          java.lang.Class<? extends Link> clazz)

Parameters:

targetID - The target vertex ID.

clazz - The link data class

Returns:

If the vertex has any Links of specified class to vertex with given targetID.

removeLinks

public void removeLinks()

Removes all the vertex's links.

removeLinks

public void removeLinks(java.lang.Class<? extends Link> clazz)

Removes all vertex's links of a given type.

Parameters:

clazz - The link data class.

removeLinksTo

public void removeLinksTo(long targetID)

Removes the vertex's links to a certain target ID.

Parameters:

targetID - ID of the vertex you want to remove the link to.

removeLinksTo

public void removeLinksTo(long targetID,
                          java.lang.Class<? extends Link> clazz)

Removes the vertex's links to a certain targetID of a given type.

Parameters:

targetID - ID of the vertex you want to remove the link to.

clazz - The link data class.

addLink

public <L extends Link> L addLink(long vertexID,
                                  java.lang.Class<L> clazz)

addLink(long, Class, Consumer) without a data injector so no initial function is run for links.

addLink

public <L extends Link> L addLink(long vertexID,
                                  java.lang.Class<L> clazz,
                                  java.util.function.Consumer<L> dataInjector)

Create a new link from this vertex to the target vertexID, with the given associated data.

Parameters:

vertexID - ID of the vertex to link to.

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

Returns:

The created Link.

addLink

public <L extends Link> L addLink(simudyne.core.graph.PreSpawnedAgent<?> preSpawnedAgent,
                                  java.lang.Class<L> clazz)

addLink(PreSpawnedAgent, Class, Consumer) without a data injector so no initial function is run for links.

addLink

public <L extends Link> L addLink(simudyne.core.graph.PreSpawnedAgent<?> preSpawnedAgent,
                                  java.lang.Class<L> clazz,
                                  java.util.function.Consumer<L> dataInjector)

Create a new link from this vertex to the target vertexID, with the given associated data.

Parameters:

preSpawnedAgent - spawned agent to link to.

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

Returns:

The created Link.

addLinks

public <L extends Link> java.util.List<L> addLinks(java.util.Collection<java.lang.Long> vertexIDs,
                                                   java.lang.Class<L> clazz)

addLinks(Collection, Class) without a data injector so no initial function is run for links.

addLinks

public <L extends Link> java.util.List<L> addLinks(java.util.Collection<java.lang.Long> vertexIDs,
                                                   java.lang.Class<L> clazz,
                                                   java.util.function.Consumer<L> dataInjector)

Create a new link from this vertex to a group of target vertexIDs, with the given associated data.

Parameters:

vertexIDs - Collection of IDs of the vertex to link to.

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

Returns:

The created Link.

setEnvironment

protected void setEnvironment(Environment<BGS> env)

dispose

public void dispose()

getEnvironment

protected Environment<BGS> getEnvironment()