desmoj.extensions.space3D

Class SpatialLayoutManager

java.lang.Object

desmoj.extensions.space3D.SpatialLayoutManager

public class SpatialLayoutManager
extends java.lang.Object

This class organizes the layout files and Track objects. This instance manages all the tracks in this model. Models can be insert and removed during the simulation.

Author:

Fred Sun

Constructor Summary

Constructors

Constructor and Description
SpatialLayoutManager()

Method Summary

Modifier and Type	Method and Description
void	addSpatialObject(java.lang.String name, SpatialObject spatialObject) Register a new SpatialObject.
void	addTrack(Track track) Register a new track.
static SpatialLayoutManager	getSpatialLayoutManager() Returns the singleton SpatialLayoutManager.
SpatialObject	getSpatialObject(java.lang.String objectName) Returns the SpatialObject with the specified name.
Track	getTrack(MovableSpatialObject mover, SpatialObject destination) Gets a registered track which leads the moving object to the destiny.
Track	getTrack(SpatialObject startLocation, java.lang.String exitPointName, SpatialObject destinationLocation, java.lang.String entryPointName) Gets the track base on the given start- and destination location.
Track	getTrack(java.lang.String name) Search through the registered tracks for a track with the given name.
java.util.Iterator<Track>	getTracksIterator() Get an iterator of all the tracks managed by this layout manager.
SimpleTrack	getTrackStraightTo(MovableSpatialObject mover, java.lang.String exitPoint, Length x, Length y, Length z) Generates a SimpleTrack which leads directly to the given position.
SimpleTrack	getTrackStraightTo(MovableSpatialObject mover, java.lang.String exitPoint, SpatialObject destination, java.lang.String entryPoint) Generates a SimpleTrack which leads directly to the given destination.
boolean	removeTrack(Track track) Removes a specific track from the layout manager.
void	setTrace(boolean showInTrace) Sets the flag, whether the tracks generated from this class should be traced or not.
boolean	showTrace() Gets whether the showInTrace flag will be set at generating a new Track.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialLayoutManager

public SpatialLayoutManager()

Method Detail

getSpatialLayoutManager

public static SpatialLayoutManager getSpatialLayoutManager()

Returns the singleton SpatialLayoutManager.

Returns:

The SpatialLayoutManager

addSpatialObject

public void addSpatialObject(java.lang.String name,
                             SpatialObject spatialObject)

Register a new SpatialObject.

Parameters:

name - The name of the SpatialObject.

spatialObject - The SpatialObject to be registered.

addTrack

public void addTrack(Track track)

Register a new track.

Parameters:

track - The track to be registered.

getSpatialObject

public SpatialObject getSpatialObject(java.lang.String objectName)

Returns the SpatialObject with the specified name.

Parameters:

objectName - The name of the SpatialObject to be get.

Returns:

The SpatialObject with the specified name.

getTrack

public Track getTrack(MovableSpatialObject mover,
                      SpatialObject destination)

Gets a registered track which leads the moving object to the destiny. If no appropriate track between them can be found, null will be returned.
If the moving object isn't located at any SpatialObject, a SimpleTrack which leads it directly to the destiny will be generated and returned.

The parameter destiny must be specified.

Parameters:

mover - The object which should move to the destiny.

destination - The destiny the mover should move to.

Returns:

A track which lead the mover to the destiny. Null, if the mover is located at a SpatialObject and no track between it and the destiny is found.

getTrack

public Track getTrack(SpatialObject startLocation,
                      java.lang.String exitPointName,
                      SpatialObject destinationLocation,
                      java.lang.String entryPointName)

Gets the track base on the given start- and destination location. The specific entry and exit point are optional. If it's given, they also will be considered as a search condition.

Parameters:

startLocation - The start location.

exitPointName - The exit point at the start location.

destinationLocation - The destination location.

entryPointName - The entry point at the destination location.

Returns:

The track which matches the given parameter

getTrack

public Track getTrack(java.lang.String name)

Search through the registered tracks for a track with the given name. If none of the registered track has the given name, null will be returned.

Parameters:

name - The name of the track which should be get.

Returns:

The track with the specified name. Null, if there is none.

getTrackStraightTo

public SimpleTrack getTrackStraightTo(MovableSpatialObject mover,
                                      java.lang.String exitPoint,
                                      SpatialObject destination,
                                      java.lang.String entryPoint)

Generates a SimpleTrack which leads directly to the given destination. If the mover object is currently at a SpatialObject (current location), an exit point of this SpatialObject can be specified as start position of the track.
Otherwise the position of the current location will be the start position.
If the mover isn't at any SpatialObject, its current position will be the start position of the track.
The entry point of the destination location can also be specified. If this parameter is set to null, the position of the destination location will be used as the destination position of the generated SimpleTrack

Parameters:

mover - The object which should move to the given position.

exitPoint - The specific exit point which should be the start position of the generated track.

destination - The destination object the mover should steered directly into.

entryPoint - The specific entry point of the destination object.

Returns:

A SimpleTrack which lead the mover object directly to the given destination.

getTrackStraightTo

public SimpleTrack getTrackStraightTo(MovableSpatialObject mover,
                                      java.lang.String exitPoint,
                                      Length x,
                                      Length y,
                                      Length z)

Generates a SimpleTrack which leads directly to the given position. If the mover object is currently at a SpatialObject (current location), an exit point of this SpatialObject can be specified as start position of the track.
Otherwise the position of the current location will be the start position.
If the mover isn't at any SpatialObject, its current position will be the start position of the track.

Parameters:

mover - The object which should move to the given position.

exitPoint - The specific exit point which should be the start position of the generated track.

x - The x-coordinate of the destiny position.

y - The y-coordinate of the destiny position.

z - The z-coordinate of the destiny position.

Returns:

A SimpleTrack which lead the mover object directly to the given position.

getTracksIterator

public java.util.Iterator<Track> getTracksIterator()

Get an iterator of all the tracks managed by this layout manager.

Returns:

An iterator of all the tracks registered.

removeTrack

public boolean removeTrack(Track track)

Removes a specific track from the layout manager. If the same track exist more than once in the track list of the manager, the first one will be removed.

Parameters:

track - The track to be removed.

Returns:

True, if the layout manager contains the given track. False, if it doesn't.

setTrace

public void setTrace(boolean showInTrace)

Sets the flag, whether the tracks generated from this class should be traced or not. At constructing of these tracks, the showInTrace flag will be set with this value.

Parameters:

showInTrace - The showInTrace flag which will be forwarded at to the constructor of the Track.

showTrace

public boolean showTrace()

Gets whether the showInTrace flag will be set at generating a new Track.

Returns:

True if the generated tracks will be traced. False, if not.