Package com.amalgamasimulation.graphagent

Class AgentGraphArcImpl

java.lang.Object

com.amalgamasimulation.graphagent.AgentGraphArcImpl

All Implemented Interfaces:

AgentGraphArc, GeometricGraphArc

Direct Known Subclasses:

LongAgentGraphArcImpl

public class AgentGraphArcImpl
extends Object
implements AgentGraphArc

Simple implementation of AgentGraphArc interface that is suitable in most simple cases. Contains the generic implementations of all methods of this interface.

Author:

Andrey Malykhanov

Constructor Summary

Constructors

Constructor	Description
AgentGraphArcImpl(Polyline polyline)	Creates a new instance of AgentGraphArcImpl with the specified Polyline.
AgentGraphArcImpl(Polyline polyline, AgentGraphArcImpl reverseArc)	Creates a new instance of AgentGraphArcImpl with the specified Polyline and reverse arc.

Method Summary

Modifier and Type	Method	Description
void	addAgent(GraphAgent<?,?> graphAgent)	Adds the specified agent to this arc, e.g.
void	addCallbackPosition(GeometricGraphPosition<?,?> position)	Adds the specified callback position to this arc.
void	afterAgentEntered(GraphAgent<?,?> graphAgent)	Callback method called after an agent enters this arc.
void	beforeAgentExited(GraphAgent<?,?> graphAgent)	Callback method called before an agent exits this arc.
void	clearCallbackPositions()	Removes all callback positions from this arc, if any.
boolean	containsAgent(GraphAgent<?,?> graphAgent)	Checks whether the specified agent is currently on this arc.
List<GraphAgent<?,?>>	getAgents()	Returns an unmodifiable list of agents that are currently on this arc.
List<GeometricGraphPosition<?,?>>	getCallbackPositions()	Returns an unmodifiable list of all callback positions belonging to this arc.
Polyline	getPolyline()	Returns the Polyline corresponding to this arc.
AgentGraphArc	getReverseArc()	Returns the arc that is a reverse to this one, or null if this is a one-way arc.
double	getReverseOffset(double offset)	Returns the absolute offset of this point on the reverse arc, if there is a reverse arc.
void	onAgentReachedPosition(GraphAgent<?,?> graphAgent, GeometricGraphPosition<?,?> position)	Callback method called when an agent reaches the specified callback position belonging to this arc.
void	onAgentVelocityChanged(GraphAgent<?,?> graphAgent)	Callback method called immediately after velocity of the specified agent located on this arc changes.
void	recalculateAgents(GraphAgent<?,?> exceptAgent, boolean recalculateReverseArc)	Recalculates the internal events (specifically, events of reaching other agents) for all agents on this arc, except for the specified one.
void	removeAgent(GraphAgent<?,?> graphAgent)	Removes the specified agent from this arc, e.g.
void	removeCallbackPosition(GeometricGraphPosition<?,?> position)	Removes the specified callback position previously added by AgentGraphArc.addCallbackPosition(GeometricGraphPosition) method from this arc.
void	setPolyline(Polyline polyline)	Sets the specified polyline to this arc.
void	setReverseArc(GeometricGraphArc reverseArc)	Sets the reverse arc to this one.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amalgamasimulation.graphagent.GeometricGraphArc

getLength

Constructor Details

AgentGraphArcImpl

public AgentGraphArcImpl(Polyline polyline)

Creates a new instance of AgentGraphArcImpl with the specified Polyline.

Parameters:

polyline - specified polyline

AgentGraphArcImpl

public AgentGraphArcImpl(Polyline polyline,
 AgentGraphArcImpl reverseArc)

Creates a new instance of AgentGraphArcImpl with the specified Polyline and reverse arc.

Parameters:

polyline - specified polyline

reverseArc - specified reverse arc

Method Details

addAgent

public void addAgent(GraphAgent<?,?> graphAgent)

Description copied from interface: AgentGraphArc

Adds the specified agent to this arc, e.g. when the agent enters this arc or jumps to it.

Specified by:

addAgent in interface AgentGraphArc

Parameters:

graphAgent - agent being added

removeAgent

public void removeAgent(GraphAgent<?,?> graphAgent)

Description copied from interface: AgentGraphArc

Removes the specified agent from this arc, e.g. when the agent leaves this arc or is completely removed from graph environment.

Specified by:

removeAgent in interface AgentGraphArc

Parameters:

graphAgent - agent being removed

onAgentVelocityChanged

public void onAgentVelocityChanged(GraphAgent<?,?> graphAgent)

Description copied from interface: AgentGraphArc

Callback method called immediately after velocity of the specified agent located on this arc changes.

Specified by:

onAgentVelocityChanged in interface AgentGraphArc

Parameters:

graphAgent - agent whose velocity has just been changed

recalculateAgents

public void recalculateAgents(GraphAgent<?,?> exceptAgent,
 boolean recalculateReverseArc)

Description copied from interface: AgentGraphArc

Recalculates the internal events (specifically, events of reaching other agents) for all agents on this arc, except for the specified one.

Specified by:

recalculateAgents in interface AgentGraphArc

Parameters:

exceptAgent - agent for which the recalculation is not performed

recalculateReverseArc - whether or not to recalculate agents on the reverse arc, if any

getAgents

public List<GraphAgent<?,?>> getAgents()

Description copied from interface: AgentGraphArc

Returns an unmodifiable list of agents that are currently on this arc.

Specified by:

getAgents in interface AgentGraphArc

Returns:

unmodifiable list of agents that are currently on this arc

containsAgent

public boolean containsAgent(GraphAgent<?,?> graphAgent)

Description copied from interface: AgentGraphArc

Checks whether the specified agent is currently on this arc.

Specified by:

containsAgent in interface AgentGraphArc

Parameters:

graphAgent - specified agent

Returns:

true if the specified agent is currently on this arc, false otherwise

See Also:

• GraphAgent.isOnArc()
• GraphAgent.getCurrentArc()

setPolyline

public void setPolyline(Polyline polyline)

Sets the specified polyline to this arc. This is a mutating method that must be used with caution only for initialization purposes.

Parameters:

polyline - specified polyline

getPolyline

public Polyline getPolyline()

Description copied from interface: GeometricGraphArc

Returns the Polyline corresponding to this arc.

Specified by:

getPolyline in interface GeometricGraphArc

Returns:

Polyline corresponding to this arc

getReverseArc

public AgentGraphArc getReverseArc()

Description copied from interface: GeometricGraphArc

Returns the arc that is a reverse to this one, or null if this is a one-way arc.

Specified by:

getReverseArc in interface AgentGraphArc

Specified by:

getReverseArc in interface GeometricGraphArc

Returns:

reverse arc, or null

setReverseArc

public void setReverseArc(GeometricGraphArc reverseArc)

Description copied from interface: GeometricGraphArc

Sets the reverse arc to this one. Normally used only when constructing the graph.

Specified by:

setReverseArc in interface GeometricGraphArc

Parameters:

reverseArc - reverse arc to this one

See Also:

• GeometricGraphArc.getReverseArc()

getReverseOffset

public double getReverseOffset(double offset)

Description copied from interface: GeometricGraphArc

Returns the absolute offset of this point on the reverse arc, if there is a reverse arc. Otherwise, returns Double.NaN.

Specified by:

getReverseOffset in interface GeometricGraphArc

Parameters:

offset - absolute offset of the point on this arc

Returns:

absolute offset of the same point on the reverse arc, or Double.NaN

addCallbackPosition

public void addCallbackPosition(GeometricGraphPosition<?,?> position)

Description copied from interface: AgentGraphArc

Adds the specified callback position to this arc. The callback method AgentGraphArc.onAgentReachedPosition(GraphAgent, GeometricGraphPosition) will be called every time an GraphAgent reaches the specified position.

Specified by:

addCallbackPosition in interface AgentGraphArc

Parameters:

position - specified callback position

See Also:

• AgentGraphArc.onAgentReachedPosition(GraphAgent, GeometricGraphPosition)
• AgentGraphArc.removeCallbackPosition(GeometricGraphPosition)
• AgentGraphArc.clearCallbackPositions()

removeCallbackPosition

public void removeCallbackPosition(GeometricGraphPosition<?,?> position)

Description copied from interface: AgentGraphArc

Removes the specified callback position previously added by AgentGraphArc.addCallbackPosition(GeometricGraphPosition) method from this arc. Does nothing if there is no specified callback position on this arc.

Specified by:

removeCallbackPosition in interface AgentGraphArc

Parameters:

position - specified callback position

See Also:

• AgentGraphArc.addCallbackPosition(GeometricGraphPosition)
• AgentGraphArc.clearCallbackPositions()

clearCallbackPositions

public void clearCallbackPositions()

Description copied from interface: AgentGraphArc

Removes all callback positions from this arc, if any.

Specified by:

clearCallbackPositions in interface AgentGraphArc

See Also:

• AgentGraphArc.addCallbackPosition(GeometricGraphPosition)
• AgentGraphArc.removeCallbackPosition(GeometricGraphPosition)

getCallbackPositions

public List<GeometricGraphPosition<?,?>> getCallbackPositions()

Description copied from interface: AgentGraphArc

Returns an unmodifiable list of all callback positions belonging to this arc.

Specified by:

getCallbackPositions in interface AgentGraphArc

Returns:

unmodifiable list of all callback positions belonging to this arc

afterAgentEntered

public void afterAgentEntered(GraphAgent<?,?> graphAgent)

Description copied from interface: AgentGraphArc

Callback method called after an agent enters this arc.

Specified by:

afterAgentEntered in interface AgentGraphArc

Parameters:

graphAgent - agent that have just entered this arc

See Also:

• AgentGraphArc.beforeAgentExited(GraphAgent)

beforeAgentExited

public void beforeAgentExited(GraphAgent<?,?> graphAgent)

Description copied from interface: AgentGraphArc

Callback method called before an agent exits this arc.

Specified by:

beforeAgentExited in interface AgentGraphArc

Parameters:

graphAgent - agent that is about to exit this arc

See Also:

• AgentGraphArc.afterAgentEntered(GraphAgent)

onAgentReachedPosition

public void onAgentReachedPosition(GraphAgent<?,?> graphAgent,
 GeometricGraphPosition<?,?> position)

Description copied from interface: AgentGraphArc

Callback method called when an agent reaches the specified callback position belonging to this arc.

Specified by:

onAgentReachedPosition in interface AgentGraphArc

Parameters:

graphAgent - agent that have reached the specified callback position

position - specified callback position

toString

public String toString()

Overrides:

toString in class Object