Package com.amalgamasimulation.graphagent

Class AgentGraphNodeImpl

java.lang.Object

com.amalgamasimulation.graphagent.AgentGraphNodeImpl

All Implemented Interfaces:

AgentGraphNode, GeometricGraphNode

Direct Known Subclasses:

LongAgentGraphNodeImpl

public class AgentGraphNodeImpl
extends Object
implements AgentGraphNode

Simple implementation of AgentGraphNode 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
AgentGraphNodeImpl(Point point)	Creates a new instance of AgentGraphNodeImpl with the specified Point.

Method Summary

Modifier and Type	Method	Description
void	addAgent(GraphAgent graphAgent)	Adds the specified agent to this node, e.g.
void	addCallbackPosition(GeometricGraphPosition position)	Adds the specified callback position to this node.
void	afterAgentEntered(GraphAgent graphAgent)	Callback method called after an agent enters this node.
void	beforeAgentExited(GraphAgent graphAgent)	Callback method called before an agent exits this node.
void	clearCallbackPositions()	Removes all callback positions from this node.
boolean	containsAgent(GraphAgent graphAgent)	Checks whether the specified agent is at this node.
List<GraphAgent>	getAgents()	Returns an unmodifiable list of agents that are currently at this node.
List<GeometricGraphPosition>	getCallbackPositions()	Returns an unmodifiable list of all callback positions belonging to this node.
Point	getPoint()	Returns the Point that defines the geometric location of this node in a geometric graph.
void	onAgentReachedPosition(GraphAgent graphAgent, GeometricGraphPosition position)	Callback method called when an agent reaches a callback position belonging to this node.
void	removeAgent(GraphAgent graphAgent)	Removes the specified agent from this node, e.g.
void	removeCallbackPosition(GeometricGraphPosition position)	Removes the specified callback position previously added by AgentGraphNode.addCallbackPosition(GeometricGraphPosition) method, from this node.
void	setPoint(Point point)	Sets the specified point to this node.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AgentGraphNodeImpl

public AgentGraphNodeImpl(Point point)

Creates a new instance of AgentGraphNodeImpl with the specified Point.

Parameters:

point - specified point

Method Details

addAgent

public void addAgent(GraphAgent graphAgent)

Description copied from interface: AgentGraphNode

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

Specified by:

addAgent in interface AgentGraphNode

Parameters:

graphAgent - agent being added

removeAgent

public void removeAgent(GraphAgent graphAgent)

Description copied from interface: AgentGraphNode

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

Specified by:

removeAgent in interface AgentGraphNode

Parameters:

graphAgent - agent being removed

getAgents

public List<GraphAgent> getAgents()

Description copied from interface: AgentGraphNode

Returns an unmodifiable list of agents that are currently at this node.

Specified by:

getAgents in interface AgentGraphNode

Returns:

unmodifiable list of agents that are currently at this node

containsAgent

public boolean containsAgent(GraphAgent graphAgent)

Description copied from interface: AgentGraphNode

Checks whether the specified agent is at this node.

Specified by:

containsAgent in interface AgentGraphNode

Parameters:

graphAgent - specified agent

Returns:

true if this agent is at this node, false otherwise

getPoint

public Point getPoint()

Description copied from interface: GeometricGraphNode

Returns the Point that defines the geometric location of this node in a geometric graph.

Specified by:

getPoint in interface GeometricGraphNode

Returns:

a Point representing this node's location in two-dimensional space

setPoint

public void setPoint(Point point)

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

Parameters:

point - specified point

addCallbackPosition

public void addCallbackPosition(GeometricGraphPosition position)

Description copied from interface: AgentGraphNode

Adds the specified callback position to this node. A AgentGraphNode.onAgentReachedPosition(GraphAgent, GeometricGraphPosition) will be called every time an agent reaches this node.

Specified by:

addCallbackPosition in interface AgentGraphNode

Parameters:

position - specified callback position

See Also:

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

removeCallbackPosition

public void removeCallbackPosition(GeometricGraphPosition position)

Description copied from interface: AgentGraphNode

Removes the specified callback position previously added by AgentGraphNode.addCallbackPosition(GeometricGraphPosition) method, from this node. Does nothing if the specified callback position does not belong to this node.

Specified by:

removeCallbackPosition in interface AgentGraphNode

Parameters:

position - callback position being removed

See Also:

• AgentGraphNode.addCallbackPosition(GeometricGraphPosition)
• AgentGraphNode.clearCallbackPositions()

clearCallbackPositions

public void clearCallbackPositions()

Description copied from interface: AgentGraphNode

Removes all callback positions from this node.

Specified by:

clearCallbackPositions in interface AgentGraphNode

See Also:

• AgentGraphNode.addCallbackPosition(GeometricGraphPosition)

getCallbackPositions

public List<GeometricGraphPosition> getCallbackPositions()

Description copied from interface: AgentGraphNode

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

Specified by:

getCallbackPositions in interface AgentGraphNode

Returns:

unmodifiable list of all callback positions belonging to this node

afterAgentEntered

public void afterAgentEntered(GraphAgent graphAgent)

Description copied from interface: AgentGraphNode

Callback method called after an agent enters this node.

Specified by:

afterAgentEntered in interface AgentGraphNode

Parameters:

graphAgent - agent that have just entered this node

beforeAgentExited

public void beforeAgentExited(GraphAgent graphAgent)

Description copied from interface: AgentGraphNode

Callback method called before an agent exits this node.

Specified by:

beforeAgentExited in interface AgentGraphNode

Parameters:

graphAgent - agent that is about to exit this node

onAgentReachedPosition

public void onAgentReachedPosition(GraphAgent graphAgent,
 GeometricGraphPosition position)

Description copied from interface: AgentGraphNode

Callback method called when an agent reaches a callback position belonging to this node.

Specified by:

onAgentReachedPosition in interface AgentGraphNode

Parameters:

graphAgent - agent that have reached the specified callback position

position - the position that have been reached

toString

public String toString()

Overrides:

toString in class Object