Package com.amalgamasimulation.graphagent

Class LongAgentsEnvironment<N extends LongAgentGraphNode,A extends LongAgentGraphArc,K extends LongAgentWeightKey>

java.lang.Object

com.amalgamasimulation.graphagent.GraphEnvironment<N,A,LongAgentWeightKey>

com.amalgamasimulation.graphagent.LongAgentsEnvironment<N,A,K>

Type Parameters:

N - type of graph node values

A - type of graph arc values

K - type of keys that are used when determining agent-dependent weight of graph arcs and nodes

Direct Known Subclasses:

TrainsEnvironment

public class LongAgentsEnvironment<N extends LongAgentGraphNode,A extends LongAgentGraphArc,K extends LongAgentWeightKey>
extends GraphEnvironment<N,A,LongAgentWeightKey>

Environment for long agents (see LongAgent class). Supports collisions tracking and spatial constraints for long agents. Long agents can live only in this type of environments.

Author:

Andrey Malykhanov

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Graph<N,A>.Arc,LongAgent<N,A>>	arcsToSeizingAgents
protected Map<Graph<N,A>.Arc,List<LongAgent<N,A>>>	arcsToWaitingAgents

Fields inherited from class com.amalgamasimulation.graphagent.GraphEnvironment

agents, barrierArcsCache, barrierArcsEnabled, cachedMinTreesWithAgents, cachedMinTreesWithoutAgents, cachedShortestPathsWeights, cachedShortestPathsWithAgents, cachedShortestPathsWithoutAgents, callbackPositionsEnabled, collisionsTrackingEnabled, graph, minTreeCacheEnabled, pathsCacheEnabled, pathsCalculated, pathsCalculatedFromDijkstra, pathsCalculatedFromTree, pathsGotFromCache

Constructor Summary

Constructors

Constructor	Description
LongAgentsEnvironment()
LongAgentsEnvironment(boolean collisionsTrackingEnabled, boolean callbackPositionsEnabled, boolean pathsCacheEnabled, boolean minTreeCacheEnabled, boolean barrierArcsEnabled)

Method Summary

Modifier and Type	Method	Description
boolean	barrierArcsCacheEnabled()
protected List<Pair<LongAgent<?,?>,GeometricGraphPath<N,A>>>	getAgentsOverlay(GeometricGraphPath<N,A> expectedOverlayPath)
double	getArcWeight(A arcValue, LongAgentWeightKey weightKey)	Returns the weight of the specified arc used when calculating the shortest paths for agents' movements.
double	getNodeWeight(N nodeValue, LongAgentWeightKey weightKey)	Returns the weight of the specified node used when calculating the shortest path for agents' movements.
AgentGraphPath<N,A>	getShortestPath(GeometricGraphPosition<N,A> sourcePosition, GeometricGraphPosition<N,A> destPosition, GraphAgent<N,A> agent)	Returns the shortest path from the specified source position to the specified destination position for the specified agent, or null if no such path exists.
void	onReleasedArcEntrance(LongAgent<N,A> agent, Graph<N,A>.Arc arc)
void	onSeizedArcEntrance(LongAgent<N,A> agent, Graph<N,A>.Arc arc)
boolean	tryEnterArc(LongAgent<N,A> agent, Graph<N,A>.Arc arc)
LongAgentWeightKey	weightKey(GraphAgent<N,A> agent)	Returns the key that is used as additional parameter when calculating weights of nodes and arcs for the purposes of shortest paths calculation for the specified agent.

Methods inherited from class com.amalgamasimulation.graphagent.GraphEnvironment

addAgentInternal, addArc, addArc, addNode, calculatePathWeight, clearCache, getAgents, getArcs, getArcValues, getClosestNodes, getClosestNodes, getClosestNodes, getClosestNodes, getClosestNodes, getClosestNodes, getClosestNodes, getClosestNodes, getClosestNodes, getCurrentCacheFactor, getCurrentDijsktraFactor, getDestsAndWeights, getGraph, getGraphArc, getGraphNode, getNodes, getNodeValues, getPartialArcWeight, getSameOrReverseArcPath, getShortestPath, getShortestPath, getShortestPath, getShortestPath, getShortestPath, getShortestPath, getShortestPath, getShortestPathBetweenNodesInternal, getShortestPathToClosest, getSourcesAndWeights, isCallbackPositionsEnabled, isCollisionsTrackingEnabled, onArcWeightChanged, pathsCacheEnabled, removeAgentInternal, tryGetZeroLengthPathBetweenAdjacentPositions

Methods inherited from class java.lang.Object

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

Field Details

arcsToSeizingAgents

protected Map<Graph<N extends LongAgentGraphNode,A extends LongAgentGraphArc>.Arc,LongAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>> arcsToSeizingAgents

arcsToWaitingAgents

protected Map<Graph<N extends LongAgentGraphNode,A extends LongAgentGraphArc>.Arc,List<LongAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>>> arcsToWaitingAgents

Constructor Details

LongAgentsEnvironment

public LongAgentsEnvironment()

LongAgentsEnvironment

public LongAgentsEnvironment(boolean collisionsTrackingEnabled,
 boolean callbackPositionsEnabled,
 boolean pathsCacheEnabled,
 boolean minTreeCacheEnabled,
 boolean barrierArcsEnabled)

Method Details

getArcWeight

public double getArcWeight(A arcValue,
 LongAgentWeightKey weightKey)

Description copied from class: GraphEnvironment

Returns the weight of the specified arc used when calculating the shortest paths for agents' movements. Can be overridden in subclasses. The default implementation returns the length of the specified arc, i.e.:

return arcValue.getLength();

Overrides:

getArcWeight in class GraphEnvironment<N extends LongAgentGraphNode,A extends LongAgentGraphArc,LongAgentWeightKey>

Parameters:

arcValue - specified arc

weightKey - an additional parameter used to parameterize the calculation if necessary. For example, can be agent if the paths should be calculated differently for each agent

Returns:

weight of this arc, must be non-negative

getNodeWeight

public double getNodeWeight(N nodeValue,
 LongAgentWeightKey weightKey)

Description copied from class: GraphEnvironment

Returns the weight of the specified node used when calculating the shortest path for agents' movements. Can be overridden in subclasses. The default implementation returns 0, so by default nodes do not contribute to paths' weights.

The default implementation is to return zero, i.e.:

return 0;

Overrides:

getNodeWeight in class GraphEnvironment<N extends LongAgentGraphNode,A extends LongAgentGraphArc,LongAgentWeightKey>

Parameters:

nodeValue - specified node

weightKey - an additional parameter used to parameterize the calculation if necessary. For example, can be agent if the paths should be calculated differently for each agent

Returns:

weight of this node, must be non-negative

weightKey

public LongAgentWeightKey weightKey(GraphAgent<N,A> agent)

Description copied from class: GraphEnvironment

Returns the key that is used as additional parameter when calculating weights of nodes and arcs for the purposes of shortest paths calculation for the specified agent. Can be overridden in subclasses. Default implementation returns null, so all the agents have the same context while calculating their paths.

An example of weight key can be some type of agent if paths need to be calculated differently for agent of different types

Overrides:

weightKey in class GraphEnvironment<N extends LongAgentGraphNode,A extends LongAgentGraphArc,LongAgentWeightKey>

Parameters:

agent - specified agent

Returns:

weight key

barrierArcsCacheEnabled

public boolean barrierArcsCacheEnabled()

onSeizedArcEntrance

public void onSeizedArcEntrance(LongAgent<N,A> agent,
 Graph<N,A>.Arc arc)

onReleasedArcEntrance

public void onReleasedArcEntrance(LongAgent<N,A> agent,
 Graph<N,A>.Arc arc)

tryEnterArc

public boolean tryEnterArc(LongAgent<N,A> agent,
 Graph<N,A>.Arc arc)

getShortestPath

public AgentGraphPath<N,A> getShortestPath(GeometricGraphPosition<N,A> sourcePosition,
 GeometricGraphPosition<N,A> destPosition,
 GraphAgent<N,A> agent)

Description copied from class: GraphEnvironment

Returns the shortest path from the specified source position to the specified destination position for the specified agent, or null if no such path exists.

Shortest path is determined using the weights provided in the methods:

• GraphEnvironment.getArcWeight(AgentGraphArc, Object)
• GraphEnvironment.getPartialArcWeight(AgentGraphArc, double, double, double, double, Object)
• GraphEnvironment.getNodeWeight(AgentGraphNode, Object)

The default implementation of these methods returns simple distance-based weights, however these methods can be overridden to customize the path finding logic.

Overrides:

getShortestPath in class GraphEnvironment<N extends LongAgentGraphNode,A extends LongAgentGraphArc,LongAgentWeightKey>

Parameters:

sourcePosition - the origin of path finding

destPosition - the destination of path finding

agent - the agent for which the path is being searched

Returns:

an instance of AgentGraphPath representing the shortest path, or null

getAgentsOverlay

protected List<Pair<LongAgent<?,?>,GeometricGraphPath<N,A>>> getAgentsOverlay(GeometricGraphPath<N,A> expectedOverlayPath)