Package com.amalgamasimulation.graphagent

Class AgentGraphPath<N extends AgentGraphNode,A extends AgentGraphArc>

java.lang.Object

com.amalgamasimulation.graph.GraphPath<N,A>

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

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

Type Parameters:

N - type of graph node values

A - type of graph arc values

public class AgentGraphPath<N extends AgentGraphNode,A extends AgentGraphArc>
extends GeometricGraphPath<N,A>

Path of a GraphAgent from some GeometricGraphPosition to some other, probably equal or adjacent GeometricGraphPosition.

Extends from GeometricGraphPath. In addition to that type, contains the agent's initial source position getInitialSourcePosition() and final destination position getFinalDestPosition(), that determine whether the agent must turn around in the beginning or in the end of its movement.

Author:

Andrey Malykhanov

Constructor Summary

Constructors

Constructor	Description
AgentGraphPath(AgentGraphPath<N,A> otherAgentGraphPath)
AgentGraphPath(GeometricGraphPath<N,A> geometricGraphPath)
AgentGraphPath(GeometricGraphPath<N,A> geometricGraphPath, boolean requiresTurnAtSource, boolean requiresTurnDestSource, Graph<N,A> graph)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
GeometricGraphPosition<N,A>	getFinalDestPosition()	Returns the position representing the final destination position of an agent moving along this path, i.e.
GeometricGraphPosition<N,A>	getInitialSourcePosition()	Returns the position representing the initial source position of an agent moving along this path, i.e.
AgentGraphPath<N,A>	getReversePath(Graph<N,A> graph)	Returns a reverse path of this path, i.e.
Polyline	getTrajectory()	Returns the Polyline representing the trajectory of this path.
double	getWeight()	Returns the weight of this path as calculated at the moment of its creation.
int	hashCode()
boolean	requiresTurnAtDest()	Checks whether turning around is required at the destination position of this path i.e.
boolean	requiresTurnAtSource()	Checks whether turning around is required at the source position of this path, i.e.
void	setWeight(double weight)

Methods inherited from class com.amalgamasimulation.graphagent.GeometricGraphPath

addNode, append, appendArc, containsNode, containsPosition, containsPositionOrReverse, getArcRecords, getDestPosition, getIntersection, getIntersectionIgnoreDirection, getIntersectionOffsets, getIntersectionOffsetsIgnoreDirection, getLength, getLengthAlongArc, getPolyline, getPositionAtOffset, getSourcePosition, getSubPath, getSubPathBetweenOffsets, getSubPaths, hasNonZeroIntersection, hasNonZeroIntersectionIgnoreDirection, of, of, of, of, prepend, prependArc, toString

Methods inherited from class com.amalgamasimulation.graph.GraphPath

containsArc, emptyPath, getArc, getArcs, getArcsCount, getCopy, getFirstArc, getFirstNode, getLastArc, getLastNode, getNextArc, getNode, getNodes, getNodesCount, getPrevArc, getSubPath, getSubPathFrom, getSubPathTo, isEmpty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AgentGraphPath

public AgentGraphPath(GeometricGraphPath<N,A> geometricGraphPath)

AgentGraphPath

public AgentGraphPath(AgentGraphPath<N,A> otherAgentGraphPath)

AgentGraphPath

public AgentGraphPath(GeometricGraphPath<N,A> geometricGraphPath,
 boolean requiresTurnAtSource,
 boolean requiresTurnDestSource,
 Graph<N,A> graph)

Method Details

setWeight

public void setWeight(double weight)

getTrajectory

public Polyline getTrajectory()

Returns the Polyline representing the trajectory of this path.

Returns:

Polyline representing the trajectory of this path

getWeight

public double getWeight()

Returns the weight of this path as calculated at the moment of its creation.

Returns:

weight of this path

requiresTurnAtSource

public boolean requiresTurnAtSource()

Checks whether turning around is required at the source position of this path, i.e. GeometricGraphPath.getSourcePosition() is not equal to getInitialSourcePosition().

Returns:

true if turning around is required at the source position of this path, false otherwise

See Also:

• GeometricGraphPath.getSourcePosition()
• getInitialSourcePosition()

requiresTurnAtDest

public boolean requiresTurnAtDest()

Checks whether turning around is required at the destination position of this path i.e. GeometricGraphPath.getDestPosition() is not equal to getFinalDestPosition().

Returns:

true if turning around is required at the destination position of this path, false otherwise

See Also:

• GeometricGraphPath.getDestPosition()
• getFinalDestPosition()

getInitialSourcePosition

public GeometricGraphPosition<N,A> getInitialSourcePosition()

Returns the position representing the initial source position of an agent moving along this path, i.e. the position before possible turning around. Two cases are possible:

1. If an agent can start moving along this path without turning around, then getInitialSourcePosition() is equal to GeometricGraphPath.getSourcePosition()
2. If the path starts on an arc that has a reverse arc, and an agent must turn around to the reverse arc before starting to move along this path, then getInitialSourcePosition() is equal to reverse of GeometricGraphPath.getSourcePosition()

Returns:

initial source position of an agent moving along this path

See Also:

• requiresTurnAtSource()
• GeometricGraphPosition.getReverse(Graph)

getFinalDestPosition

public GeometricGraphPosition<N,A> getFinalDestPosition()

Returns the position representing the final destination position of an agent moving along this path, i.e. the position after possible turning around at the very end of agent's movement. Two cases are possible:

1. If an agent does not need to turn around to reach its destination position, then getFinalDestPosition() is equal to GeometricGraphPath.getDestPosition()
2. If the path ends on an arc that has a reverse arc, and an agent must turn around just before reaching its destination, then getFinalDestPosition() is equal to reverse of GeometricGraphPath.getDestPosition()

Returns:

final destination position of an agent moving along this path

See Also:

• requiresTurnAtDest()
• GeometricGraphPosition.getReverse(Graph)

equals

public boolean equals(Object other)

Overrides:

equals in class GeometricGraphPath<N extends AgentGraphNode,A extends AgentGraphArc>

hashCode

public int hashCode()

Overrides:

hashCode in class GeometricGraphPath<N extends AgentGraphNode,A extends AgentGraphArc>

getReversePath

public AgentGraphPath<N,A> getReversePath(Graph<N,A> graph)

Description copied from class: GeometricGraphPath

Returns a reverse path of this path, i.e. the path along all the opposite arcs in the reversed order.

If this path contains at least one arc that does not have a reverse arc, a IllegalStateException will be thrown

If this path is a zero-length path, the returned path will also be a zero-length path

Overrides:

getReversePath in class GeometricGraphPath<N extends AgentGraphNode,A extends AgentGraphArc>

Returns:

a new instance of GeometricGraphPath() that is reverse path of this one