desmoj.extensions.space3D

Class Track

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.extensions.space3D.Track

Direct Known Subclasses:

SimpleTrack

public abstract class Track
extends ModelComponent

This is the basic class of the Track. All Tracks should inherit from this class.

Author:

Fred Sun

Constructor Summary

Constructors

Constructor and Description
Track(Model owner, java.lang.String trackName, java.lang.String startLocationName, java.lang.String destinationLocationName, java.lang.String exitPointName, java.lang.String entryPointName, Length[] startPosition, Length[] destination, boolean showInTrace) Constructs a Track and initialize the basic attributes.

Method Summary

Modifier and Type	Method and Description
Length[]	getDestination() Gets the destiny position in ExtendedLength[].
double[]	getDestinationValue() Gives the end position of the Track.
java.lang.String	getDestinyLocationName() Gets the name of the destiny location.
abstract Vector3d	getDirectionAt(double length) Gets the current moving direction based on the specified length from the start position on the track.
java.lang.String	getEnrtyPointName() Gets the name of the entry point at the destiny location.
java.lang.String	getExitPointName() Gets the name of the exit point at the start location.
abstract double	getLength() Gives the total length of the Track.
abstract Length[]	getPositionAt(double length) Gets the coordinates (in ExtendedLength) of the current position based on the specified length from the start position on the track.
Length[]	getStarLengthUnits() Gets the start position in ExtendedLength[].
java.lang.String	getStartLocationName() Gets the name of the start location.
double[]	getStartPositionValue() Gives the start Position of the Track.
void	setDestinyPosition(Length[] position) Sets the destiny position of this track.
void	setStartPosition(Length[] position) Sets the start position of this track.

Methods inherited from class desmoj.core.simulator.ModelComponent

current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Track

public Track(Model owner,
             java.lang.String trackName,
             java.lang.String startLocationName,
             java.lang.String destinationLocationName,
             java.lang.String exitPointName,
             java.lang.String entryPointName,
             Length[] startPosition,
             Length[] destination,
             boolean showInTrace)

Constructs a Track and initialize the basic attributes. The name for the start- and the destiny location, the entry- and exit points are optional. The start- and the destiny position must be specified.

Parameters:

owner - The model this entity is associated to.

trackName - The name of this Track.

startLocationName - The name of the start location.

destinationLocationName - The name of the destiny location.

exitPointName - The name of the exit point.

entryPointName - The name of the entry point.

startPosition - The start position of the Track. It must be a ExtendedLength[] with a length of 3.

destination - The end position of the Track. It must be a ExtendedLength[] with a length of 3.

showInTrace - Flag for showing entity in trace-files. Set it to true if entity should show up in trace. Set to false in entity should not be shown in trace.

Method Detail

getDestinyLocationName

public java.lang.String getDestinyLocationName()

Gets the name of the destiny location.

Returns:

The name of the destiny. Null, if it'n not specified.

getDestination

public Length[] getDestination()

Gets the destiny position in ExtendedLength[]. The first element represents the x-position, the second the y-position and the third the z-position.

Returns:

The destiny position in ExtendedLength.

getDestinationValue

public double[] getDestinationValue()

Gives the end position of the Track.

Returns:

The end position in a double[3]. The value represents meters.

getDirectionAt

public abstract Vector3d getDirectionAt(double length)

Gets the current moving direction based on the specified length from the start position on the track.

Parameters:

length - The length from the start position to the current position.

Returns:

The normalized vector which points to the current moving direction.

getEnrtyPointName

public java.lang.String getEnrtyPointName()

Gets the name of the entry point at the destiny location.

Returns:

The name of the entry point. Null, if it's not specified.

getExitPointName

public java.lang.String getExitPointName()

Gets the name of the exit point at the start location.

Returns:

The name of the exit point. Null, if it's not specified.

getLength

public abstract double getLength()

Gives the total length of the Track.

Returns:

The length of the Track in a double value.

getPositionAt

public abstract Length[] getPositionAt(double length)

Gets the coordinates (in ExtendedLength) of the current position based on the specified length from the start position on the track.

Parameters:

length - The length from the start position to the position which we want to know.

Returns:

A ExtendedLength[3] array which represents the x-, y- and the z-coordinates.

getStartLocationName

public java.lang.String getStartLocationName()

Gets the name of the start location.

Returns:

The name of the start location. Null, if it's not specified.

getStarLengthUnits

public Length[] getStarLengthUnits()

Gets the start position in ExtendedLength[]. The first element represents the x-position, the second the y-position and the third the z-position.

Returns:

The start position in ExtendedLength.

getStartPositionValue

public double[] getStartPositionValue()

Gives the start Position of the Track.

Returns:

The start position in a double[3]. The value represents meters.

setStartPosition

public void setStartPosition(Length[] position)

Sets the start position of this track.

Parameters:

position - The position to be set. It must be a ExtendedLength of length 3.

setDestinyPosition

public void setDestinyPosition(Length[] position)

Sets the destiny position of this track.

Parameters:

position - The position to be set. It must be a ExtendedLength of length 3.