Package com.amalgamasimulation.graphagent

Class LongAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

java.lang.Object

com.amalgamasimulation.graphagent.GraphAgent<N,A>

com.amalgamasimulation.graphagent.LongAgent<N,A>

Type Parameters:

N - type of values stored in graph nodes

A - type of values stored in graph arcs

All Implemented Interfaces:

Agent, Timeable

Direct Known Subclasses:

Train

public class LongAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>
extends GraphAgent<N,A>

Class representing a long agent that lives and moves inside a LongAgentsEnvironment. Long agent is modeled with two regular GraphAgents:

• This agent (as a subclass of GraphAgent) represents the location of the head of the long agent.
• The other agent encapsulated inside this one represents the location of the tail of the long agent.

It is assumed that the long agent takes all the space along graph's arcs and nodes between its head and its tail.

Author:

Andrey Malykhanov

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Graph<N,A>.Node,List<LongAgent<N,A>>>	adjacentAgents
protected LongAgent<N,A>	aheadAgent
protected boolean	aheadAgentNotBlockingPath
protected GeometricGraphPath<N,A>	animatedSelfPath
protected Polyline	animationPolyline
protected LongAgent<N,A>	behindAgent
protected boolean	isPossibleStartMoveFromTail
protected double	length
protected LongAgentsEnvironment<N,A,?>	longAgentsEnvironment
protected LongAgentWeightKey	longAgentWeightKey
protected List<Graph<N,A>.Arc>	occupiedArcs
protected List<Graph<N,A>.Node>	occupiedNodes
protected double	ownVelocity
protected double	selfPathLastUpdateTime
protected boolean	shouldTurnAroundBeforeMovement
protected LongAgentTail<N,A>	tail

Fields inherited from class com.amalgamasimulation.graphagent.GraphAgent

basis, engine, lastTrajectoryNodeIndex, lastTrajectoryPointIndex

Constructor Summary

Constructors

Constructor	Description
LongAgent(Engine engine)	Creates a new instance of LongAgent that is simulated with the specified Engine.

Method Summary

Modifier and Type	Method	Description
protected void	addAdjacentAgent(Graph<N,A>.Node node, LongAgent<N,A> adjacentAgent)
void	afterEnteredArc(Graph<N,A>.Arc arc)	Callback method called immediately after entering an arc.
void	afterEnteredNode(Graph<N,A>.Node node)	Callback method called immediately after entering a node.
void	afterHeadEnteredArc(Graph<N,A>.Arc arc)	Callback method called immediately after the head of this long agent enters an arc.
void	afterHeadEnteredNode(Graph<N,A>.Node node)	Callback method called immediately after the head of this long agent enters a node.
boolean	allowEnterArc(Graph<N,A>.Arc arc)	Callback method used to implement advanced functionality like passby or waiting for something specific before entering arcs.
void	beforeExitedArc(Graph<N,A>.Arc arc)	Callback method called before exiting entering an arc.
void	beforeExitedNode(Graph<N,A>.Node node)	Callback method called before exiting a node.
void	beforeTailExitedArc(Graph<N,A>.Arc arc)	Callback method called before the tail of this long agent exits an arc.
void	beforeTailExitedNode(Graph<N,A>.Node node)	Callback method called before the tail of this long agent exits a node.
void	cancelMoving()	Stops this agent and forgets its moving path and target.
protected void	checkArcPositionForOccupancy()
protected void	checkArcsBeforeJumping(Graph<N,A>.Arc arc, double arcAbsOffset, List<Graph<N,A>.Arc> previousArcs)
protected void	checkArcsOrder(List<Graph<N,A>.Arc> arcs)
protected void	checkNodeForOccupancy(Graph<N,A>.Node node)
protected void	checkPositionsInsideAgent(List<GeometricGraphPosition<N,A>> destPositions)
protected void	checkReverseArcs(List<Graph<N,A>.Arc> arcs)
protected void	checkSelfOverlay(List<Graph<N,A>.Arc> arcs, double firstArcOffset, double lastArcOffset)
protected void	clearInternalCollections()
protected boolean	comparePathsLessThan(AgentGraphPath<N,A> firstPath, AgentGraphPath<N,A> secondPath)
protected AgentGraphPath<N,A>	createPathForTailAgent(GraphPath<N,A> path, GeometricGraphPosition<N,A> destPosition, GeometricGraphPosition<N,A> actualDestPosition)
protected void	enterArcFollowingAgent(LongAgent<N,A> newAheadAgent)
protected void	enterNodeInternal(Graph<N,A>.Node node)
protected void	eraseCurrentPathInternal()
protected void	fillOccupiedCollectionAfterSeveralArcsJumping()
List<LongAgent<N,A>>	getAdjacentAgents(Graph<N,A>.Node node)	Returns list of LongAgent which collided to this agent in the node and are waiting for it to free the node to continue moving.
LongAgent<N,A>	getAheadAgent()	Returns a LongAgent that is immediately ahead of this long agent, or null if there is no such agent.
GeometricGraphPath<N,A>	getAnimationSelfPath()	Returns the GeometricGraphPath that represents the projection of a long agent onto the graph.
LongAgent<N,A>	getBehindAgent()	Returns a LongAgent that is immediately behind this long agent, or null if there is no such agent.
Polyline	getCurrentAnimationPolyline()	Returns a Polyline representing the current location of this long agent, or null if this long agent is not in a graph.
double	getCurrentAnimationTailArcAbsOffset()	Returns the non-negative absolute offset of tail position on arc where this tail is currently located, or -1 if tail is not currently located on an arc.
Point	getCurrentHeadAnimationPoint()	Returns a Point where the head of this long agent is currently located, or null if this long agent is not in a graph.
GeometricGraphPosition<N,A>	getCurrentHeadPosition()	Returns a GeometricGraphPosition where the head of this long agent is currently located, or null if this agent is not in a graph.
Point	getCurrentTailAnimationPoint()	Returns a Point where the tail of this long agent is currently located, or null if this long agent is not in a graph.
GeometricGraphPosition<N,A>	getCurrentTailPosition()	Returns a GeometricGraphPosition where the tail of this long agent is currently located, or null if this agent is not in a graph.
double	getLength()	Returns the length of this long agent
LongAgentWeightKey	getLongAgentWeightKey()	Return LongAgentWeightKey which is responsible for calculating the weight of arcs
protected Graph<N,A>.Arc	getNextPathArc()
List<Graph<N,A>.Arc>	getOccupiedArcs()	Returns the unmodifiable list of arcs currently occupied by this long agent.
List<Graph<N,A>.Node>	getOccupiedNodes()	Returns the unmodifiable list of nodes currently occupied by this long agent.
List<GeometricGraphPosition<N,A>>	getPositionInsideAgent(List<GeometricGraphPosition<N,A>> destPositions)
GeometricGraphPath<N,A>	getSelfPath()	Returns the GeometricGraphPath that represents the projection of a long agent onto the graph.
protected AgentGraphPath<N,A>	getShortestHeadTailPath(Function<GeometricGraphPosition<N,A>,AgentGraphPath<N,A>> pathFunction)
protected AgentGraphPath<N,A>	getShortestPath(GeometricGraphPosition<N,A> destPosition)
protected AgentGraphPath<N,A>	getShortestPath(Predicate<Graph<N,A>.Node> indicator)
protected AgentGraphPath<N,A>	getShortestPathToClosest(List<GeometricGraphPosition<N,A>> destPositions)
protected boolean	isAheadAgentBlockingMovement()
boolean	isAheadAgentNotBlockingPath()	Returns true if there is another long agent that is immediately ahead of this long agent and is moving in same direction, or further movement will not have to a non-zero overlay, or false otherwise.
protected boolean	isOtherAgentInNodeHavingSameDirection(GraphAgent<?,?> otherAgent)
boolean	isPossibleStartMoveFromTail()	Return the possibility of finding the shortest path from the tail of the agent (default true).
protected boolean	isPossibleToStartMoving(double velocity)
CompletionStage<Void>	jumpTo(Graph<N,A>.Arc arc, double arcAbsOffset)	Jumps this agent to the specified absolute offset of the specified arc of graph of this agent's GraphEnvironment.
void	jumpTo(Graph<N,A>.Arc arc, double arcAbsOffset, List<Graph<N,A>.Arc> previousArcs)	Jumps this agent to the specified arc at the specified absolute offset and places it on the specified list of previous arcs.
protected void	jumpTo(Graph<N,A>.Arc arc, double arcAbsOffset, List<Graph<N,A>.Arc> previousArcs, boolean isFirsNodeIncluded, boolean isLastNodeIncluded)
CompletionStage<Void>	jumpTo(Graph<N,A>.Node node)	Jumps this agent to the specified node of graph of this agent's GraphEnvironment.
CompletionStage<Void>	jumpTo(GeometricGraphPosition<N,A> position)	Jumps this agent to the specified position.
void	jumpTo(GeometricGraphPosition<N,A> position, List<Graph<N,A>.Arc> previousArcs)	Jumps this agent to the specified position and places it on the specified list of previous arcs.
CompletionStage<Void>	jumpTo(N nodeValue)	Jumps this agent to the node having the specified value.
protected void	jumpToPathDestPosition()
protected void	jumpToSeveralArcs(Graph<N,A>.Arc arc, double arcAbsOffset, List<Graph<N,A>.Arc> previousArcs, boolean isFirsNodeIncluded, boolean isLastNodeIncluded)
CompletionStage<Void>	moveAlongPath(AgentGraphPath<N,A> path, double velocity)
CompletionStage<Void>	moveTo(Graph<N,A>.Node node, double velocity)	Starts moving this agent to the specified node in the graph with the specified velocity along the shortest path from agent's current position.
CompletionStage<Void>	moveTo(GeometricGraphPosition<N,A> destPosition, double velocity)	Starts moving this agent to the specified destination position in the graph with the specified velocity along the shortest path from agent's current position.
CompletionStage<Void>	moveTo(Predicate<Graph<N,A>.Node> indicator, double velocity)	Starts movement of the agent from the current position (node or arc) to the specified graph node along the shortest path.
CompletionStage<Void>	moveTo(N nodeValue, double velocity)	Starts moving this agent to the node in the graph having the specified value with the specified velocity along the shortest path from agent's current position.
CompletionStage<Void>	moveToClosest(List<GeometricGraphPosition<N,A>> destPositions, double velocity)	Starts moving this agent to the closest one of the specified destination positions in the graph with the specified velocity along the shortest path from this agent's current position.
protected void	onAheadAgentVelocityChanged()
void	onCollidedWithOtherAgent(GraphAgent<N,A> otherAgent, boolean isMovingInSameDirection)	Callback method called when this agent сollides another agent and further movement will have to a non-zero overlay, i.e.
void	onDestinationReached(GeometricGraphPosition<N,A> destPosition)	Callback method called after this agent reaches its destination, i.e.
void	onOtherAgentReached(GraphAgent<N,A> otherAgent, boolean isMovingInSameDirection)	Callback method called when this agent reaches another agent, i.e.
protected void	recalculateCollisions()
void	removeAdjacentAgent(LongAgent<N,A> agent)	Remove specified LongAgent from all adjacent agents collections.
protected void	removeFromGraphInternal()
void	removeNodeAdjacentAgents(Graph<N,A>.Node node)	Clear adjacent agents collection in specified node and try to continue movement of adjacent agents.
protected void	setAheadAgent(LongAgent<N,A> newAheadAgent)
protected void	setBehindAgent(LongAgent<N,A> behindAgent)
protected void	setCurrentPathInternal(AgentGraphPath<N,A> path)
void	setGraphEnvironment(GraphEnvironment<N,A,?> graphEnvironment)	Sets the GraphEnvironment to this agent.
void	setGraphEnvironment(LongAgentsEnvironment<N,A,?> graphEnvironment, double length)	Assigns this long agent to the specified LongAgentsEnvironment and specifies its length.
void	setLongAgentWeightKey(LongAgentWeightKey longAgentWeightKey)	Set specified LongAgentWeightKey which is responsible for calculating the weight of arcs
void	setPossibleStartMoveFromTail(boolean isPossibleStartMoveFromTail)	Set the possibility of finding the shortest path from the tail of the agent.
void	setVelocity(double newVelocity)	Sets the new velocity to this agent.
protected void	setVelocityInternal(double newVelocity)
protected void	startMovingAlongPath(double velocity)
void	turnAround()	Turns this long agent around, i.e.
protected void	turnAroundInternal()

Methods inherited from class com.amalgamasimulation.graphagent.GraphAgent

addCallbackPosition, cancelMovingInternal, checkEvents, clearCallbackPositions, disableCommandsExecution, enableCommandsExecution, engine, enterArcInternal, enterSegment, getCurrentAnimationArcAbsOffset, getCurrentAnimationHeading, getCurrentAnimationPoint, getCurrentAnimationTrajectoryAbsoluteOffset, getCurrentArc, getCurrentArcAbsOffset, getCurrentNode, getCurrentPoint, getCurrentPosition, getDistanceTraveled, getGraphEnvironment, getGraphPath, getHeading, getName, getTrajectory, getVelocity, hasGraphEnvironment, hasPath, isAtNode, isInGraph, isMoving, isOnArc, jumpToInternal, jumpToInternal, leaveCurrentArcInternal, leaveCurrentNodeInternal, moveToClosestInternal, moveToIndicatorInternal, moveToInternal, onCallbackPositionReached, onPathNotFound, onSegmentExited, removeCallbackPosition, removeFromGraphEnvironment, resetDistanceTraveled, time, tryExecuteCommand, tryUpdateDistanceTraveled, tryUpdatePosition

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amalgamasimulation.engine.Agent

beginDate, timeUnit

Methods inherited from interface com.amalgamasimulation.utils.time.Timeable

dateToTime, dateToTime, day, duration, hour, minute, second, timeToDate, week, wholeDays, wholeDays, wholeHours, wholeHours, wholeUnits

Field Details

length

protected double length

tail

protected LongAgentTail<N extends LongAgentGraphNode,A extends LongAgentGraphArc> tail

ownVelocity

protected double ownVelocity

aheadAgent

protected LongAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc> aheadAgent

behindAgent

protected LongAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc> behindAgent

adjacentAgents

protected Map<Graph<N extends LongAgentGraphNode,A extends LongAgentGraphArc>.Node,List<LongAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>>> adjacentAgents

aheadAgentNotBlockingPath

protected boolean aheadAgentNotBlockingPath

animationPolyline

protected Polyline animationPolyline

longAgentsEnvironment

protected LongAgentsEnvironment<N extends LongAgentGraphNode,A extends LongAgentGraphArc,?> longAgentsEnvironment

occupiedArcs

protected List<Graph<N extends LongAgentGraphNode,A extends LongAgentGraphArc>.Arc> occupiedArcs

occupiedNodes

protected List<Graph<N extends LongAgentGraphNode,A extends LongAgentGraphArc>.Node> occupiedNodes

shouldTurnAroundBeforeMovement

protected boolean shouldTurnAroundBeforeMovement

isPossibleStartMoveFromTail

protected boolean isPossibleStartMoveFromTail

longAgentWeightKey

protected LongAgentWeightKey longAgentWeightKey

animatedSelfPath

protected GeometricGraphPath<N extends LongAgentGraphNode,A extends LongAgentGraphArc> animatedSelfPath

selfPathLastUpdateTime

protected double selfPathLastUpdateTime

Constructor Details

LongAgent

public LongAgent(Engine engine)

Creates a new instance of LongAgent that is simulated with the specified Engine.

Parameters:

engine - specified engine

Method Details

setCurrentPathInternal

protected void setCurrentPathInternal(AgentGraphPath<N,A> path)

Overrides:

setCurrentPathInternal in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

setGraphEnvironment

public void setGraphEnvironment(LongAgentsEnvironment<N,A,?> graphEnvironment,
 double length)

Assigns this long agent to the specified LongAgentsEnvironment and specifies its length.

Parameters:

graphEnvironment - LongAgentsEnvironment that this long agent is assigned to

length - length of this agent

setVelocityInternal

protected void setVelocityInternal(double newVelocity)

Overrides:

setVelocityInternal in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

onOtherAgentReached

public void onOtherAgentReached(GraphAgent<N,A> otherAgent,
 boolean isMovingInSameDirection)

Description copied from class: GraphAgent

Callback method called when this agent reaches another agent, i.e. graph positions of this agent and the other agent become either equal or reverse. To be overridden in subclasses.

Overrides:

onOtherAgentReached in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

otherAgent - another agent

isMovingInSameDirection - true if both agents are moving in the same direction, false otherwise

getLength

public double getLength()

Returns the length of this long agent

Returns:

length of this long agent

onCollidedWithOtherAgent

public void onCollidedWithOtherAgent(GraphAgent<N,A> otherAgent,
 boolean isMovingInSameDirection)

Callback method called when this agent сollides another agent and further movement will have to a non-zero overlay, i.e. graph positions of this agent and the other agent become either equal or reverse. To be overridden in subclasses.

Parameters:

otherAgent - another agent

isMovingInSameDirection - true if both agents are moving in the same direction, false otherwise

turnAround

public void turnAround()

Turns this long agent around, i.e. swaps its head and tail. Occupied arcs and nodes are changed accordingly.

If this long agent is at least partially located on a monodirectional graph arc, a RuntimeException is thrown.

setVelocity

public void setVelocity(double newVelocity)

Description copied from class: GraphAgent

Sets the new velocity to this agent. If this agent is moving and the specified new velocity does not equal to agent's current velocity, this agent's velocity gets changed immediately.

Positive velocity can only be set if this agent has its path (i.e. GraphAgent.hasPath() == true). Otherwise, a RuntimeException is thrown

Negative and infinite velocities are not allowed. If such value is passed, a RuntimeException is thrown

Overrides:

setVelocity in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

newVelocity - - specified velocity

See Also:

• GraphAgent.isMoving()
• GraphAgent.getVelocity()
• GraphAgent.hasPath()

cancelMoving

public void cancelMoving()

Description copied from class: GraphAgent

Stops this agent and forgets its moving path and target. More specifically:

If this agent is moving, stops moving

If this agent has a path (even if this agent is not moving), erases this path, sets the path to null

If this agent does not have a path, does nothing

Overrides:

cancelMoving in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

See Also:

• GraphAgent.isMoving()
• GraphAgent.hasPath()
• GraphAgent.getGraphPath()

moveTo

public CompletionStage<Void> moveTo(GeometricGraphPosition<N,A> destPosition,
 double velocity)

Description copied from class: GraphAgent

Starts moving this agent to the specified destination position in the graph with the specified velocity along the shortest path from agent's current position.

The shortest path is calculated with respect to weights of arcs and nodes set in agent's GraphEnvironment.

If this agent is currently moving somewhere else, it forgets its current destination and is assigned a new path.

If zero velocity is specified, the path is set to this agent, but it just does not start moving. It can start moving when GraphAgent.setVelocity(double) is called with a positive value.

If no path is found from agent's current position to the specified position, GraphAgent.onPathNotFound(List) method is called. The default implementation of this method throws a RuntimeException, but it can be overridden in subclasses.

If this agent is not in graph or has not been assigned to a GraphEnvironment, a RuntimeException is thrown.

Overrides:

moveTo in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

destPosition - specified destination position in the graph of this agent's GraphEnvironment

velocity - specified velocity. Must be finite and non-negative

See Also:

• GraphAgent.setGraphEnvironment(GraphEnvironment)
• GraphAgent.onPathNotFound(List)
• GraphEnvironment.getShortestPath(GeometricGraphPosition, GeometricGraphPosition)

moveToClosest

public CompletionStage<Void> moveToClosest(List<GeometricGraphPosition<N,A>> destPositions,
 double velocity)

Description copied from class: GraphAgent

Starts moving this agent to the closest one of the specified destination positions in the graph with the specified velocity along the shortest path from this agent's current position.

Closeness and shortest path are determined with respect to weights of arcs and nodes set in agent's GraphEnvironment.

If this agent is currently moving somewhere else, it forgets its current destination and is assigned a new path.

If zero velocity is specified, the path is set to this agent, but it just does not start moving. It can start moving when GraphAgent.setVelocity(double) is called with a positive value.

If no path is found from agent's current position to either of the specified positions, GraphAgent.onPathNotFound(List) method is called. The default implementation of this method throws a RuntimeException, but it can be overridden in subclasses.

If this agent is not in graph or has not been assigned to a GraphEnvironment, a RuntimeException is thrown.

Overrides:

moveToClosest in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

destPositions - list of destination positions in the graph of this agent's GraphEnvironment, from which the closest one is selected

velocity - specified velocity. Must be finite and non-negative

See Also:

• GraphAgent.setGraphEnvironment(GraphEnvironment)
• GraphAgent.onPathNotFound(List)
• GraphEnvironment.getShortestPath(GeometricGraphPosition, GeometricGraphPosition)

moveTo

public CompletionStage<Void> moveTo(N nodeValue,
 double velocity)

Description copied from class: GraphAgent

Starts moving this agent to the node in the graph having the specified value with the specified velocity along the shortest path from agent's current position.

The shortest path is calculated with respect to weights of arcs and nodes set in agent's GraphEnvironment.

If this agent is currently moving somewhere else, it forgets its current destination and is assigned a new path.

If zero velocity is specified, the path is set to this agent, but it just does not start moving. It can start moving when GraphAgent.setVelocity(double) is called with a positive value.

If no path is found from agent's current position to the specified node, GraphAgent.onPathNotFound(List<GeometricGraphPosition<N, A>>) method is called. The default implementation of this method throws a RuntimeException, but it can be overridden in subclasses.

If this agent is not in graph or has not been assigned to a GraphEnvironment, a RuntimeException is thrown.

Overrides:

moveTo in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

nodeValue - value of the node in the graph of this agent's GraphEnvironment which this agent will be sent to

velocity - specified velocity. Must be finite and non-negative

See Also:

• GraphAgent.setGraphEnvironment(GraphEnvironment)
• GraphAgent.onPathNotFound(List<GeometricGraphPosition<N, A>>)
• GraphEnvironment.getShortestPath(GeometricGraphPosition, GeometricGraphPosition)

moveTo

public CompletionStage<Void> moveTo(Predicate<Graph<N,A>.Node> indicator,
 double velocity)

Description copied from class: GraphAgent

Starts movement of the agent from the current position (node or arc) to the specified graph node along the shortest path.

If no path exists between agent's current position (node or arc) to the specified node, function does nothing.
If agent already is in the specified node, function does nothing.

Overrides:

moveTo in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

indicator - the Predicate which must return true to indicate that a node is a valid destination

moveTo

public CompletionStage<Void> moveTo(Graph<N,A>.Node node,
 double velocity)

Description copied from class: GraphAgent

Starts moving this agent to the specified node in the graph with the specified velocity along the shortest path from agent's current position.

The shortest path is calculated with respect to weights of arcs and nodes set in agent's GraphEnvironment.

If this agent is currently moving somewhere else, it forgets its current destination and is assigned a new path.

If zero velocity is specified, the path is set to this agent, but it just does not start moving. It can start moving when GraphAgent.setVelocity(double) is called with a positive value.

If no path is found from agent's current position to the specified node, GraphAgent.onPathNotFound(List) method is called. The default implementation of this method throws a RuntimeException, but it can be overridden in subclasses.

If this agent is not in graph or has not been assigned to a GraphEnvironment, a RuntimeException is thrown.

Overrides:

moveTo in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

node - node in the graph of this agent's GraphEnvironment which this agent will be sent to

velocity - specified velocity. Must be finite and non-negative

See Also:

• GraphAgent.setGraphEnvironment(GraphEnvironment)
• GraphAgent.onPathNotFound(List)
• GraphEnvironment.getShortestPath(GeometricGraphPosition, GeometricGraphPosition)

getShortestPathToClosest

protected AgentGraphPath<N,A> getShortestPathToClosest(List<GeometricGraphPosition<N,A>> destPositions)

Overrides:

getShortestPathToClosest in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

getShortestPath

protected AgentGraphPath<N,A> getShortestPath(GeometricGraphPosition<N,A> destPosition)

Overrides:

getShortestPath in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

getShortestPath

protected AgentGraphPath<N,A> getShortestPath(Predicate<Graph<N,A>.Node> indicator)

Overrides:

getShortestPath in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

getShortestHeadTailPath

protected AgentGraphPath<N,A> getShortestHeadTailPath(Function<GeometricGraphPosition<N,A>,AgentGraphPath<N,A>> pathFunction)

enterNodeInternal

protected void enterNodeInternal(Graph<N,A>.Node node)

Overrides:

enterNodeInternal in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

checkNodeForOccupancy

protected void checkNodeForOccupancy(Graph<N,A>.Node node)

checkArcPositionForOccupancy

protected void checkArcPositionForOccupancy()

isOtherAgentInNodeHavingSameDirection

protected boolean isOtherAgentInNodeHavingSameDirection(GraphAgent<?,?> otherAgent)

Overrides:

isOtherAgentInNodeHavingSameDirection in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

getNextPathArc

protected Graph<N,A>.Arc getNextPathArc()

checkPositionsInsideAgent

protected void checkPositionsInsideAgent(List<GeometricGraphPosition<N,A>> destPositions)

getPositionInsideAgent

public List<GeometricGraphPosition<N,A>> getPositionInsideAgent(List<GeometricGraphPosition<N,A>> destPositions)

comparePathsLessThan

protected boolean comparePathsLessThan(AgentGraphPath<N,A> firstPath,
 AgentGraphPath<N,A> secondPath)

onAheadAgentVelocityChanged

protected void onAheadAgentVelocityChanged()

setBehindAgent

protected void setBehindAgent(LongAgent<N,A> behindAgent)

addAdjacentAgent

protected void addAdjacentAgent(Graph<N,A>.Node node,
 LongAgent<N,A> adjacentAgent)

removeNodeAdjacentAgents

public void removeNodeAdjacentAgents(Graph<N,A>.Node node)

Clear adjacent agents collection in specified node and try to continue movement of adjacent agents.

Parameters:

node - specified node

See Also:

• getAdjacentAgents(com.amalgamasimulation.graph.Graph.Node)

removeAdjacentAgent

public void removeAdjacentAgent(LongAgent<N,A> agent)

Remove specified LongAgent from all adjacent agents collections.

Parameters:

agent - specified agent

See Also:

• getAdjacentAgents(com.amalgamasimulation.graph.Graph.Node)

getAdjacentAgents

public List<LongAgent<N,A>> getAdjacentAgents(Graph<N,A>.Node node)

Returns list of LongAgent which collided to this agent in the node and are waiting for it to free the node to continue moving.

Parameters:

node - specified node

Returns:

list of LongAgent which collided to this agent in the node and are waiting for it to free the node to continue moving

getCurrentHeadPosition

public GeometricGraphPosition<N,A> getCurrentHeadPosition()

Returns a GeometricGraphPosition where the head of this long agent is currently located, or null if this agent is not in a graph.

Returns:

GeometricGraphPosition where the head of this long agent is currently located, or null

See Also:

• GraphAgent.isInGraph()

getCurrentTailPosition

public GeometricGraphPosition<N,A> getCurrentTailPosition()

Returns a GeometricGraphPosition where the tail of this long agent is currently located, or null if this agent is not in a graph.

Returns:

GeometricGraphPosition where the tail of this long agent is currently located, or null

See Also:

• GraphAgent.isInGraph()

getCurrentHeadAnimationPoint

public Point getCurrentHeadAnimationPoint()

Returns a Point where the head of this long agent is currently located, or null if this long agent is not in a graph.

The result of this method is equal to the result of GraphAgent.getCurrentAnimationPoint() method.

Returns:

Point where the head of this long agent is currently located, or null

See Also:

• GraphAgent.isInGraph()

getCurrentTailAnimationPoint

public Point getCurrentTailAnimationPoint()

Returns a Point where the tail of this long agent is currently located, or null if this long agent is not in a graph.

Returns:

Point where the tail of this long agent is currently located, or null

See Also:

• GraphAgent.isInGraph()

getCurrentAnimationPolyline

public Polyline getCurrentAnimationPolyline()

Returns a Polyline representing the current location of this long agent, or null if this long agent is not in a graph.

Returns:

Polyline representing the current location of this long agent, or null

See Also:

• GraphAgent.isInGraph()

getAheadAgent

public LongAgent<N,A> getAheadAgent()

Returns a LongAgent that is immediately ahead of this long agent, or null if there is no such agent.

Another agent is considered immediately behind ahead of this one if:

• this agent moves in the same direction and head of this agent is at the same position as other agent's tail, or
• another agent moves in the opposite direction along a bidirectional arc and heads of both agents are at the adjacent positions (see GeometricGraphPosition.equalsOrAdjacent(GeometricGraphPosition, Graph)).

Returns:

LongAgent that is immediately ahead of this long agent, or null

See Also:

• getBehindAgent()
• isAheadAgentNotBlockingPath()

isAheadAgentNotBlockingPath

public boolean isAheadAgentNotBlockingPath()

Returns true if there is another long agent that is immediately ahead of this long agent and is moving in same direction, or further movement will not have to a non-zero overlay, or false otherwise.

Returns:

true if there is another long agent that is immediately ahead of this long agent and is moving in same direction, or further movement will not have to a non-zero overlay, or false otherwise

See Also:

• getAheadAgent()

getBehindAgent

public LongAgent<N,A> getBehindAgent()

Returns a LongAgent that is immediately behind this long agent, or null if there is no such agent.

Another agent is considered immediately behind this one if it moves in the same direction and its head is at the same position as this agent's tail.

Returns:

LongAgent that is immediately behind this long agent, or null

See Also:

• getAheadAgent()

eraseCurrentPathInternal

protected void eraseCurrentPathInternal()

Overrides:

eraseCurrentPathInternal in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

createPathForTailAgent

protected AgentGraphPath<N,A> createPathForTailAgent(GraphPath<N,A> path,
 GeometricGraphPosition<N,A> destPosition,
 GeometricGraphPosition<N,A> actualDestPosition)

jumpTo

public CompletionStage<Void> jumpTo(GeometricGraphPosition<N,A> position)

Description copied from class: GraphAgent

Jumps this agent to the specified position. If this agent is moving or has a path, cancels its movement and forgets its path before jumping.

Overrides:

jumpTo in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

position - position in the graph of this agent's GraphEnvironment where this agent will be placed

jumpTo

public CompletionStage<Void> jumpTo(Graph<N,A>.Node node)

Description copied from class: GraphAgent

Jumps this agent to the specified node of graph of this agent's GraphEnvironment. If this agent is moving or has a path, cancels its movement and forgets its path before jumping.

Overrides:

jumpTo in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

node - node of the graph of this agent's GraphEnvironment where this agent will be placed

jumpTo

public CompletionStage<Void> jumpTo(Graph<N,A>.Arc arc,
 double arcAbsOffset)

Description copied from class: GraphAgent

Jumps this agent to the specified absolute offset of the specified arc of graph of this agent's GraphEnvironment. If this agent is moving or has a path, cancels its movement and forgets its path before jumping.

Overrides:

jumpTo in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

arc - arc of the graph of this agent's GraphEnvironment where this agent will be placed

arcAbsOffset - absolute offset of the specified arc where this agent will be placed

jumpTo

public CompletionStage<Void> jumpTo(N nodeValue)

Description copied from class: GraphAgent

Jumps this agent to the node having the specified value. If this agent is moving or has a path, cancels its movement and forgets its path before jumping.

Overrides:

jumpTo in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

nodeValue - value of the node in the graph of this agent's GraphEnvironment where this agent will be placed

startMovingAlongPath

protected void startMovingAlongPath(double velocity)

Overrides:

startMovingAlongPath in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

setGraphEnvironment

public void setGraphEnvironment(GraphEnvironment<N,A,?> graphEnvironment)

Description copied from class: GraphAgent

Sets the GraphEnvironment to this agent. This agent starts to live in the specified graph environment after this call. If this agent has been assigned to some other graph environment, removes it from that graph environment before placing into the specified one.

Overrides:

setGraphEnvironment in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

graphEnvironment - graph environment to be set to this agent

allowEnterArc

public boolean allowEnterArc(Graph<N,A>.Arc arc)

Description copied from class: GraphAgent

Callback method used to implement advanced functionality like passby or waiting for something specific before entering arcs. The basic implementation is always to return true. To be overridden in subclasses.

Overrides:

allowEnterArc in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

arc - arc that this agent attempts to enter

Returns:

true if this agent should be allowed to enter the specified arc, false otherwise

isPossibleToStartMoving

protected boolean isPossibleToStartMoving(double velocity)

Overrides:

isPossibleToStartMoving in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

isAheadAgentBlockingMovement

protected boolean isAheadAgentBlockingMovement()

beforeTailExitedArc

public void beforeTailExitedArc(Graph<N,A>.Arc arc)

Callback method called before the tail of this long agent exits an arc. To be overridden in subclasses. The tail of this long agent is still in the specified arc when this method is called.

Parameters:

arc - arc being exited by the tail of this long agent

afterHeadEnteredArc

public void afterHeadEnteredArc(Graph<N,A>.Arc arc)

Callback method called immediately after the head of this long agent enters an arc. To be overridden in subclasses. The head of this long agent is already on the specified arc when this method is called.

Parameters:

arc - arc being entered by the head of this long agent

afterHeadEnteredNode

public void afterHeadEnteredNode(Graph<N,A>.Node node)

Callback method called immediately after the head of this long agent enters a node. To be overridden in subclasses. The head of this long agent is already in the specified node when this method is called.

Parameters:

node - node being entered by the head of this long agent

beforeTailExitedNode

public void beforeTailExitedNode(Graph<N,A>.Node node)

Callback method called before the tail of this long agent exits a node. To be overridden in subclasses. The tail of this long agent is still in the specified node when this method is called

Parameters:

node - node being exited by the tail of this long agent

afterEnteredNode

public void afterEnteredNode(Graph<N,A>.Node node)

Description copied from class: GraphAgent

Callback method called immediately after entering a node. To be overridden in subclasses. This agent is already in the specified node when this method is called

Overrides:

afterEnteredNode in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

node - node being entered

See Also:

• GraphAgent.beforeExitedNode(com.amalgamasimulation.graph.Graph.Node)

beforeExitedNode

public void beforeExitedNode(Graph<N,A>.Node node)

Description copied from class: GraphAgent

Callback method called before exiting a node. To be overridden in subclasses. This agent is still in the specified node when this method is called

Overrides:

beforeExitedNode in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

node - node being exited

See Also:

• GraphAgent.afterEnteredNode(com.amalgamasimulation.graph.Graph.Node)

afterEnteredArc

public void afterEnteredArc(Graph<N,A>.Arc arc)

Description copied from class: GraphAgent

Callback method called immediately after entering an arc. To be overridden in subclasses. This agent is already on the specified arc when this method is called

Event of entering an arc can happen in 3 cases:

in process of moving

after jumping to a position on the specified arc

after turning to opposite arc

Overrides:

afterEnteredArc in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

arc - arc being entered

See Also:

• GraphAgent.beforeExitedArc(com.amalgamasimulation.graph.Graph.Arc)

onDestinationReached

public void onDestinationReached(GeometricGraphPosition<N,A> destPosition)

Description copied from class: GraphAgent

Callback method called after this agent reaches its destination, i.e. the final position of its path. The destination is determined as final position of any movement initiated by any overload of moveTo or moveToClosest method.

Note that jumpTo methods do not initiate movements and thus do not lead to calling this callback.

Overrides:

onDestinationReached in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

destPosition - the position that has been reached

See Also:

• GraphAgent.moveTo(GeometricGraphPosition, double)
• GraphAgent.moveTo(AgentGraphNode, double)
• GraphAgent.moveTo(com.amalgamasimulation.graph.Graph.Node, double)
• GraphAgent.moveTo(Predicate, double)
• GraphAgent.moveToClosest(List, double)

enterArcFollowingAgent

protected void enterArcFollowingAgent(LongAgent<N,A> newAheadAgent)

getOccupiedArcs

public List<Graph<N,A>.Arc> getOccupiedArcs()

Returns the unmodifiable list of arcs currently occupied by this long agent. Arcs are ordered from head to tail of this long agent. Both fully and partially occupied arcs are included into the list.

Returns:

list of arcs currently occupied by this long agent

getOccupiedNodes

public List<Graph<N,A>.Node> getOccupiedNodes()

Returns the unmodifiable list of nodes currently occupied by this long agent. Nodes are ordered from head to tail of this long agent.

Returns:

list of nodes currently occupied by this long agent

beforeExitedArc

public void beforeExitedArc(Graph<N,A>.Arc arc)

Description copied from class: GraphAgent

Callback method called before exiting entering an arc. To be overridden in subclasses. This agent is still on the specified arc when this method is called

Event of exiting an arc can happen in 3 cases:

in process of moving

before jumping from current position on an arc

before turning to opposite arc

Overrides:

beforeExitedArc in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

Parameters:

arc - arc being exited

See Also:

• GraphAgent.afterEnteredArc(com.amalgamasimulation.graph.Graph.Arc)

turnAroundInternal

protected void turnAroundInternal()

moveAlongPath

public CompletionStage<Void> moveAlongPath(AgentGraphPath<N,A> path,
 double velocity)

Overrides:

moveAlongPath in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

removeFromGraphInternal

protected void removeFromGraphInternal()

Overrides:

removeFromGraphInternal in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

recalculateCollisions

protected void recalculateCollisions()

clearInternalCollections

protected void clearInternalCollections()

jumpTo

public void jumpTo(Graph<N,A>.Arc arc,
 double arcAbsOffset,
 List<Graph<N,A>.Arc> previousArcs)

Jumps this agent to the specified arc at the specified absolute offset and places it on the specified list of previous arcs. If this agent is moving or has a path, cancels its movement and forgets its path before jumping.

Parameters:

arc - specified arc

arcAbsOffset - absolute offset on the specified arc

previousArcs - list of arcs where to place this long agent

jumpTo

protected void jumpTo(Graph<N,A>.Arc arc,
 double arcAbsOffset,
 List<Graph<N,A>.Arc> previousArcs,
 boolean isFirsNodeIncluded,
 boolean isLastNodeIncluded)

jumpToSeveralArcs

protected void jumpToSeveralArcs(Graph<N,A>.Arc arc,
 double arcAbsOffset,
 List<Graph<N,A>.Arc> previousArcs,
 boolean isFirsNodeIncluded,
 boolean isLastNodeIncluded)

fillOccupiedCollectionAfterSeveralArcsJumping

protected void fillOccupiedCollectionAfterSeveralArcsJumping()

checkArcsBeforeJumping

protected void checkArcsBeforeJumping(Graph<N,A>.Arc arc,
 double arcAbsOffset,
 List<Graph<N,A>.Arc> previousArcs)

checkArcsOrder

protected void checkArcsOrder(List<Graph<N,A>.Arc> arcs)

checkReverseArcs

protected void checkReverseArcs(List<Graph<N,A>.Arc> arcs)

checkSelfOverlay

protected void checkSelfOverlay(List<Graph<N,A>.Arc> arcs,
 double firstArcOffset,
 double lastArcOffset)

jumpToPathDestPosition

protected void jumpToPathDestPosition()

Overrides:

jumpToPathDestPosition in class GraphAgent<N extends LongAgentGraphNode,A extends LongAgentGraphArc>

jumpTo

public void jumpTo(GeometricGraphPosition<N,A> position,
 List<Graph<N,A>.Arc> previousArcs)

Jumps this agent to the specified position and places it on the specified list of previous arcs. If this agent is moving or has a path, cancels its movement and forgets its path before jumping.

Parameters:

position - position where this agent is jumped

previousArcs - list of arcs where to place this long agent

setAheadAgent

protected void setAheadAgent(LongAgent<N,A> newAheadAgent)

isPossibleStartMoveFromTail

public boolean isPossibleStartMoveFromTail()

Return the possibility of finding the shortest path from the tail of the agent (default true).

Returns:

the possibility of finding the shortest path from the tail of the agent (default true)

setPossibleStartMoveFromTail

public void setPossibleStartMoveFromTail(boolean isPossibleStartMoveFromTail)

Set the possibility of finding the shortest path from the tail of the agent.

Parameters:

isPossibleStartMoveFromTail - possibility of finding the shortest path from the tail of the agent (default true)

getLongAgentWeightKey

public LongAgentWeightKey getLongAgentWeightKey()

Return LongAgentWeightKey which is responsible for calculating the weight of arcs

Returns:

LongAgentWeightKey which is responsible for calculating the weight of arcs

setLongAgentWeightKey

public void setLongAgentWeightKey(LongAgentWeightKey longAgentWeightKey)

Set specified LongAgentWeightKey which is responsible for calculating the weight of arcs

Parameters:

longAgentWeightKey - LongAgentWeightKey which is responsible for calculating the weight of arcs

getCurrentAnimationTailArcAbsOffset

public double getCurrentAnimationTailArcAbsOffset()

Returns the non-negative absolute offset of tail position on arc where this tail is currently located, or -1 if tail is not currently located on an arc.

Returns:

absolute offset of position on arc where tail is currently located, or -1

See Also:

• GraphAgent.getCurrentArcAbsOffset()
• GraphAgent.getCurrentArc()

getAnimationSelfPath

public GeometricGraphPath<N,A> getAnimationSelfPath()

Returns the GeometricGraphPath that represents the projection of a long agent onto the graph. This method should be called from animation when it is needed to determine where to show this agent. Calling getSelfPath() from animation might result in non-reproducibility of the model.

Returns:

Returns the @GeometricGraphPath that represents the projection of a long agent onto the graph.

getSelfPath

public GeometricGraphPath<N,A> getSelfPath()

Returns the GeometricGraphPath that represents the projection of a long agent onto the graph. This method must not be called from animation. Calling getSelfPath() from animation might result in non-reproducibility of the model. getAnimationSelfPath() should be called from animation instead of this.

Returns:

Returns the @GeometricGraphPath that represents the projection of a long agent onto the graph.