desmoj.extensions.visualization2d.engine.model

Class List

java.lang.Object

desmoj.extensions.visualization2d.engine.model.List

All Implemented Interfaces:

Basic, ClassBasic

public class List
extends java.lang.Object
implements Basic

A list of entities, entities are sorted by priority. Grafical properties are stired in ListGrafic

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 java.lang.String	PREFIX_BIN_CONSUMER
static java.lang.String	PREFIX_QUEUE
static java.lang.String	PREFIX_RESOURCE
static java.lang.String	PREFIX_STOCK_CONSUMER
static java.lang.String	PREFIX_STOCK_PRODUCER
static java.lang.String	PREFIX_WAIT_MASTER
static java.lang.String	PREFIX_WAIT_SLAVE
static java.lang.String	PRIO_FIRST
static java.lang.String	PRIO_LAST

Constructor Summary

Constructors

Constructor and Description
List(Model model, java.lang.String praefix, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
boolean	addToContainer(java.lang.String entityId, int priority, java.lang.String priorityRule, long time) add entity to container
boolean	addToContainerAfter(java.lang.String entityId, int priority, java.lang.String entityAfterId, long time) Add entity after a given entity
boolean	addToContainerBefore(java.lang.String entityId, int priority, java.lang.String entityBeforeId, long time) Add entity before a given entity
boolean	containsInContainer(java.lang.String entityId) check if it contains a entity with entityId
Grafic	createGrafic(java.lang.String viewId, int x, int y, java.lang.String defaultEntityTypeId, int anzVisible, boolean horizontal) create a ListGrafic instance
Grafic	createGrafic(java.lang.String viewId, int x, int y, java.lang.String defaultEntityTypeId, int anzVisible, boolean horizontal, java.awt.Dimension deltaSize) create a ListGrafic instance
java.lang.String[]	getAllContentFromContainer() get an array with id's of all entities in container
java.awt.Color	getCommentColor()
java.awt.Font	getCommentFont()
java.lang.String	getCommentText()
java.lang.String[][]	getContent() get content of list
Grafic	getGrafic() get a ListGrafic instance, created before
java.lang.String	getId()
Model	getModel()
java.lang.String	getName()
boolean	isCommentSizeExt()
boolean	removeFromContainer(java.lang.String entityId, long time) remove entity from list entityId time operation-time
void	setCommentColor(java.awt.Color color)
void	setCommentFont(int style, int size)
void	setCommentSizeExt(boolean commentSizeExt)
void	setCommentTest(java.lang.String text)
void	setName(java.lang.String name) set list-name

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX_QUEUE

public static final java.lang.String PREFIX_QUEUE

See Also:

Constant Field Values

PREFIX_RESOURCE

public static final java.lang.String PREFIX_RESOURCE

See Also:

Constant Field Values

PREFIX_BIN_CONSUMER

public static final java.lang.String PREFIX_BIN_CONSUMER

See Also:

Constant Field Values

PREFIX_STOCK_CONSUMER

public static final java.lang.String PREFIX_STOCK_CONSUMER

See Also:

Constant Field Values

PREFIX_STOCK_PRODUCER

public static final java.lang.String PREFIX_STOCK_PRODUCER

See Also:

Constant Field Values

PREFIX_WAIT_MASTER

public static final java.lang.String PREFIX_WAIT_MASTER

See Also:

Constant Field Values

PREFIX_WAIT_SLAVE

public static final java.lang.String PREFIX_WAIT_SLAVE

See Also:

Constant Field Values

PRIO_FIRST

public static final java.lang.String PRIO_FIRST

See Also:

Constant Field Values

PRIO_LAST

public static final java.lang.String PRIO_LAST

See Also:

Constant Field Values

Constructor Detail

List

public List(Model model,
            java.lang.String praefix,
            java.lang.String id)

Parameters:

model - used animation.model.Model

praefix -

id -

Method Detail

getModel

public Model getModel()

Specified by:

getModel in interface Basic

getId

public java.lang.String getId()

Specified by:

getId in interface ClassBasic

setName

public void setName(java.lang.String name)

set list-name

Parameters:

name -

getName

public java.lang.String getName()

Specified by:

getName in interface Basic

getCommentText

public java.lang.String getCommentText()

setCommentTest

public void setCommentTest(java.lang.String text)

getCommentColor

public java.awt.Color getCommentColor()

setCommentColor

public void setCommentColor(java.awt.Color color)

getCommentFont

public java.awt.Font getCommentFont()

setCommentFont

public void setCommentFont(int style,
                           int size)

isCommentSizeExt

public boolean isCommentSizeExt()

setCommentSizeExt

public void setCommentSizeExt(boolean commentSizeExt)

containsInContainer

public boolean containsInContainer(java.lang.String entityId)

check if it contains a entity with entityId

Parameters:

entityId -

Returns:

getAllContentFromContainer

public java.lang.String[] getAllContentFromContainer()

get an array with id's of all entities in container

Returns:

array with id's

createGrafic

public Grafic createGrafic(java.lang.String viewId,
                           int x,
                           int y,
                           java.lang.String defaultEntityTypeId,
                           int anzVisible,
                           boolean horizontal)

create a ListGrafic instance

Parameters:

viewId - Id of view

x - x-coordinate of middlepoint

y - y-coordinate of middlepoint

defaultEntityTypeId - for sizing

anzVisible - nr of visible entities

horizontal - "horizontal" or "vertical"

Returns:

ListGrafic

createGrafic

public Grafic createGrafic(java.lang.String viewId,
                           int x,
                           int y,
                           java.lang.String defaultEntityTypeId,
                           int anzVisible,
                           boolean horizontal,
                           java.awt.Dimension deltaSize)

create a ListGrafic instance

Parameters:

viewId - Id of view

x - x-coordinate of middlepoint

y - y-coordinate of middlepoint

defaultEntityTypeId - for sizing

anzVisible - nr of visible entities

horizontal - "horizontal" or "vertical"

deltaSize - increment/decrement size of grafic [in pixel]

Returns:

ListGrafic

getGrafic

public Grafic getGrafic()

get a ListGrafic instance, created before

Specified by:

getGrafic in interface Basic

addToContainer

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

add entity to container

Parameters:

entityId - Id of entity to insert

priority - priority of entity to insert

priorityRule - posible Values: List.FIRST, List.LAST

time - simulation-time of operating

Returns:

Throws:

ModelException

addToContainerAfter

public boolean addToContainerAfter(java.lang.String entityId,
                                   int priority,
                                   java.lang.String entityAfterId,
                                   long time)
                            throws ModelException

Add entity after a given entity

Parameters:

entityId - Id of entity to insert

priority - priority of new entity

entityAfterId - Id of after entity

time - simulation time of operation

Throws:

ModelException

addToContainerBefore

public boolean addToContainerBefore(java.lang.String entityId,
                                    int priority,
                                    java.lang.String entityBeforeId,
                                    long time)
                             throws ModelException

Add entity before a given entity

Parameters:

entityId - Id of entity to insert

priority - priority of new entity

entityBeforeId - Id of before entity

time - simulation time of operation

Throws:

ModelException

removeFromContainer

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

remove entity from list entityId time operation-time

Throws:

ModelException

getContent

public java.lang.String[][] getContent()

get content of list

Returns:

(entity-id, rank)