desmoj.extensions.visualization2d.engine.model

Class Route

java.lang.Object

desmoj.extensions.visualization2d.engine.model.Container<java.lang.Long>

desmoj.extensions.visualization2d.engine.model.Route

All Implemented Interfaces:

Basic, ClassBasic

public class Route
extends Container<java.lang.Long>

A route is a polyline between a start- and a end-station. The line has a length and an entity can move on it with a velocity stored in its velocity-attribute

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

christian.mueller@th-wildau.de For information about subproject: desmoj.extensions.visualization2d please have a look at: http://www.th-wildau.de/cmueller/Desmo-J/Visualization2d/ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LINE_Size_Big
static int	LINE_Size_Normal
static int	LINE_Size_Small
static int	SHOW_DIRECTION
static int	SHOW_LENGTH
static int	SHOW_LINE
static int	SHOW_NAME
static int	SHOW_NOTHING

Constructor Summary

Constructors

Constructor and Description
Route(Model model, java.lang.String id, java.lang.String sourceId, java.lang.String sinkId, double length) Route from sourceId to sinkId with length

Method Summary

Modifier and Type	Method and Description
boolean	addToContainer(java.lang.String entityId, long time) add entityId at sourceId on route
Grafic	createGrafic(java.awt.Point[] points) create RouteGrafic as polyline with innerpoints points.
java.awt.Color	getColor() get color of route line
Grafic	getGrafic() get stationGrafic, which was ceated before
double	getLength()
int	getLineSize() get size of route line
java.lang.String	getName() name of route, can be null
java.lang.Object[][]	getRelPosition(long time) Compute the relative position of every entity in this route (container).
int	getShow() Show is the sum of Route.SHOW_ Flags
java.lang.String	getSinkId()
java.lang.String	getSourceId()
boolean	removeFromContainer(java.lang.String entityId, long time) remove entityId from route entityId time time of operation
void	setColor(java.awt.Color color) set color of route line and description
void	setLineSize(int size) set the line size, for values look at Route.LINE_Size flags
void	setName(java.lang.String name)
void	setShow(int show) Show is the sum of Route.SHOW_ Flags

Methods inherited from class desmoj.extensions.visualization2d.engine.model.Container

addToContainer, containsInContainer, getAllContentFromContainer, getFromContainer, getId, getModel, sizeOfContainer

Methods inherited from class java.lang.Object

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

Field Detail

SHOW_NOTHING

public static final int SHOW_NOTHING

See Also:

Constant Field Values

SHOW_NAME

public static final int SHOW_NAME

See Also:

Constant Field Values

SHOW_LENGTH

public static final int SHOW_LENGTH

See Also:

Constant Field Values

SHOW_DIRECTION

public static final int SHOW_DIRECTION

See Also:

Constant Field Values

SHOW_LINE

public static final int SHOW_LINE

See Also:

Constant Field Values

LINE_Size_Normal

public static final int LINE_Size_Normal

See Also:

Constant Field Values

LINE_Size_Small

public static final int LINE_Size_Small

See Also:

Constant Field Values

LINE_Size_Big

public static final int LINE_Size_Big

See Also:

Constant Field Values

Constructor Detail

Route

public Route(Model model,
             java.lang.String id,
             java.lang.String sourceId,
             java.lang.String sinkId,
             double length)

Route from sourceId to sinkId with length

Parameters:

model - used animation.model.Model

id - routeId

sourceId - station with sourceId

sinkId - station with sinkId

length - length of route

Method Detail

getName

public java.lang.String getName()

name of route, can be null

setName

public void setName(java.lang.String name)

getSourceId

public java.lang.String getSourceId()

getSinkId

public java.lang.String getSinkId()

getLength

public double getLength()

getShow

public int getShow()

Show is the sum of Route.SHOW_ Flags

Returns:

setShow

public void setShow(int show)

Show is the sum of Route.SHOW_ Flags

Parameters:

show -

getColor

public java.awt.Color getColor()

get color of route line

Returns:

setColor

public void setColor(java.awt.Color color)

set color of route line and description

Parameters:

color -

getLineSize

public int getLineSize()

get size of route line

Returns:

setLineSize

public void setLineSize(int size)

set the line size, for values look at Route.LINE_Size flags

Parameters:

size -

createGrafic

public Grafic createGrafic(java.awt.Point[] points)

create RouteGrafic as polyline with innerpoints points. The endpoints are given from source- and sink- station

Parameters:

points -

Returns:

RouteGrafic

getGrafic

public Grafic getGrafic()

get stationGrafic, which was ceated before

Specified by:

getGrafic in interface Basic

Overrides:

getGrafic in class Container<java.lang.Long>

addToContainer

public boolean addToContainer(java.lang.String entityId,
                              long time)
                       throws ModelException

add entityId at sourceId on route

Parameters:

entityId -

time - time of operation

Returns:

true, when successful

Throws:

ModelException

removeFromContainer

public boolean removeFromContainer(java.lang.String entityId,
                                   long time)
                            throws ModelException

remove entityId from route entityId time time of operation

Overrides:

removeFromContainer in class Container<java.lang.Long>

time - not used

Returns:

true, when successful

Throws:

ModelException

getRelPosition

public java.lang.Object[][] getRelPosition(long time)

Compute the relative position of every entity in this route (container). This is a value between 0 (start of route) and 1 (end of route).

Parameters:

time - actual simulation time

Returns:

getRelPosition(long time)[i][0]: key of i.th entity in route (String). getRelPosition(long time)[i][1]: relative Position of i.th entity in route (Double).