traffic3.objects

Class TrafficAgent

java.lang.Object

traffic3.objects.TrafficAgent

public class TrafficAgent
extends java.lang.Object

A TrafficAgent is a mobile object in the world.

Constructor Summary

Constructors

Constructor and Description
TrafficAgent(Human human, TrafficManager manager, double radius, double velocityLimit) Construct a TrafficAgent.

Method Summary

Modifier and Type	Method and Description
void	beginTimestep() Perform any pre-timestep activities required.
void	clearPath() Clear the path.
void	clearPositionHistory() Clear the position history and distance travelled.
void	endTimestep() Perform any post-timestep activities required.
TrafficArea	getArea() Get the TrafficArea the agent is currently in.
Point2D	getCurrentDestination() Get the current (possibly intermediate) destination.
PathElement	getCurrentElement() Get the current (possibly intermediate) path element.
Point2D	getFinalDestination() Get the final destination.
double	getFX() Get the total X force on this agent.
double	getFY() Get the total Y force on this agent.
Human	getHuman() Get the Human wrapped by this object.
double	getMaxVelocity() Get the maximum velocity of this agent.
java.util.List<PathElement>	getPath() Get the current path.
java.util.List<Point2D>	getPositionHistory() Get the position history.
double	getRadius() Get the radius of this agent.
double	getTravelDistance() Get the distance travelled so far.
double	getVX() Get the X velocity of this agent.
double	getVY() Get the Y velocity of this agent.
double	getX() Get the X coordinate of this agent.
double	getY() Get the Y coordinate of this agent.
boolean	isMobile() Find out if this agent is mobile.
void	setLocation(double x, double y) Set the location of this agent.
void	setMaxVelocity(double vLimit) Set the maximum velocity of this agent.
void	setMobile(boolean m) Set whether this agent is mobile or not.
void	setPath(java.util.List<PathElement> steps) Set the path this agent wants to take.
void	setPositionHistoryEnabled(boolean b) Enable or disable position history recording.
void	setPositionHistoryFrequency(int n) Set the frequency of position history records.
void	setRadius(double r) Set the radius of this agent.
void	setVerbose(boolean b) Turn verbose logging on or off.
void	step(double dt) Execute a microstep.
java.lang.String	toLongString() Get a long version of the toString method.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TrafficAgent

public TrafficAgent(Human human,
                    TrafficManager manager,
                    double radius,
                    double velocityLimit)

Construct a TrafficAgent.

Parameters:

human - The Human wrapped by this object.

manager - The traffic manager.

radius - The radius of this agent in mm.

velocityLimit - The velicity limit.

Method Detail

getHuman

public Human getHuman()

Get the Human wrapped by this object.

Returns:

The wrapped Human.

getMaxVelocity

public double getMaxVelocity()

Get the maximum velocity of this agent.

Returns:

The maximum velocity.

setMaxVelocity

public void setMaxVelocity(double vLimit)

Set the maximum velocity of this agent.

Parameters:

vLimit - The new maximum velocity.

getArea

public TrafficArea getArea()

Get the TrafficArea the agent is currently in.

Returns:

The current TrafficArea.

getPositionHistory

public java.util.List<Point2D> getPositionHistory()

Get the position history.

Returns:

The position history.

getTravelDistance

public double getTravelDistance()

Get the distance travelled so far.

Returns:

The distance travelled.

clearPositionHistory

public void clearPositionHistory()

Clear the position history and distance travelled.

setPositionHistoryFrequency

public void setPositionHistoryFrequency(int n)

Set the frequency of position history records. One record will be created every nth microstep.

Parameters:

n - The new frequency.

setPositionHistoryEnabled

public void setPositionHistoryEnabled(boolean b)

Enable or disable position history recording.

Parameters:

b - True to enable position history recording, false otherwise.

getX

public double getX()

Get the X coordinate of this agent.

Returns:

The X coordinate.

getY

public double getY()

Get the Y coordinate of this agent.

Returns:

The Y coordinate.

getFX

public double getFX()

Get the total X force on this agent.

Returns:

The total X force in N.

getFY

public double getFY()

Get the total Y force on this agent.

Returns:

The total Y force in N.

getVX

public double getVX()

Get the X velocity of this agent.

Returns:

The X velocity in mm/s.

getVY

public double getVY()

Get the Y velocity of this agent.

Returns:

The Y velocity in mm/s.

setRadius

public void setRadius(double r)

Set the radius of this agent.

Parameters:

r - The new radius in mm.

getRadius

public double getRadius()

Get the radius of this agent.

Returns:

The radius in mm.

setPath

public void setPath(java.util.List<PathElement> steps)

Set the path this agent wants to take.

Parameters:

steps - The new path.

clearPath

public void clearPath()

Clear the path.

getFinalDestination

public Point2D getFinalDestination()

Get the final destination.

Returns:

The final destination

getCurrentDestination

public Point2D getCurrentDestination()

Get the current (possibly intermediate) destination.

Returns:

The current destination.

getCurrentElement

public PathElement getCurrentElement()

Get the current (possibly intermediate) path element.

Returns:

The current path element.

getPath

public java.util.List<PathElement> getPath()

Get the current path.

Returns:

The path.

setLocation

public void setLocation(double x,
                        double y)

Set the location of this agent. This method will also update the position history (if enabled).

Parameters:

x - location x

y - location y

beginTimestep

public void beginTimestep()

Perform any pre-timestep activities required.

step

public void step(double dt)

Execute a microstep.

Parameters:

dt - The amount of time to simulate in ms.

endTimestep

public void endTimestep()

Perform any post-timestep activities required.

setMobile

public void setMobile(boolean m)

Set whether this agent is mobile or not.

Parameters:

m - True if this agent is mobile, false otherwise.

isMobile

public boolean isMobile()

Find out if this agent is mobile.

Returns:

True if this agent is mobile.

setVerbose

public void setVerbose(boolean b)

Turn verbose logging on or off.

Parameters:

b - True for piles of debugging output, false for smaller piles.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toLongString

public java.lang.String toLongString()

Get a long version of the toString method.

Returns:

A long description of this agent.