desmoj.extensions.visualization2d.engine.model

Class Entity

java.lang.Object

desmoj.extensions.visualization2d.engine.model.Entity

All Implemented Interfaces:

Basic, ClassBasic

public class Entity
extends java.lang.Object
implements Basic

An entity is a basic-object of animation. Every entity has an entity-type. Basic-properties of an entity e.g. possible attributes or states are definied in entity-type. The history of all values are stored also. All grafical properies are stored in EntityGrafic

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.

Constructor Summary

Constructors

Constructor and Description
Entity(Model model, java.lang.String id, java.lang.String entityTypeId, java.lang.String state, long time) An new entity will indexed automaticly in classContent hashtable

Method Summary

Modifier and Type	Method and Description
void	changeContainer(java.lang.String type, java.lang.String id, java.lang.String op, long time) An entity will be created, add or remove a container.
Grafic	createGraficFree(long time) creates an EntityGrafic instance for an free entity
Grafic	createGraficStatic(java.lang.String viewId, double positionX, double positionY, double angle, boolean direction, long time) creates an EntityGrafic instance for an static entity with fixed position
void	dispose() Dispose this entity
boolean	existAttribute(java.lang.String key) check if attribute-key is valid
java.lang.String	getAttribute(java.lang.String key) get actual value of attribute
java.util.List<Attribute>	getAttributeHistory(java.lang.String key) get history vector of attribute
java.util.List<Attribute>	getContainerHistory() get vector of containerHistory
java.lang.String	getEntityTypeId()
Grafic	getGrafic()
java.lang.String	getId()
Model	getModel()
java.lang.String	getName() actual value of name-attribute
java.util.List<Attribute>	getNameAttribute() get vector with all historical name-keys
int	getPriority() get actual value of priority-attribute
java.util.List<Attribute>	getPriorityAttribute() get historical vector of priorities
java.lang.String	getState() get actual value of state
java.util.List<Attribute>	getStateHistory() get vector of state history
double	getVelocity() get actual velocity
java.util.List<Attribute>	getVelocityAttribute() get historical vector of velocity
boolean	isFree() An entity is static or it is in a container (list, route, process) or it is free Only a free entity can put in to a container
boolean	isStatic() An entity has a fixed location
void	setAttribute(java.lang.String key, java.lang.String value, long since) set an attribute-value
void	setNameAttribute(java.lang.String name, long time) set a new key of name-attribute This seted attribute is used as name attribute.
void	setPriorityAttribute(java.lang.String p, long time) sets new value of priority-attribute
void	setState(java.lang.String state, long time) set new state-value
void	setVelocityAttribute(java.lang.String v, long time) set new value of velocity-attribute

Methods inherited from class java.lang.Object

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

Constructor Detail

Entity

public Entity(Model model,
              java.lang.String id,
              java.lang.String entityTypeId,
              java.lang.String state,
              long time)
       throws ModelException

An new entity will indexed automaticly in classContent hashtable

Parameters:

model - used animation.model.Model

id - entityId must be unique

entityTypeId -

state - initial state

time - creation-time

Throws:

ModelException

Method Detail

getModel

public Model getModel()

Specified by:

getModel in interface Basic

getId

public java.lang.String getId()

Specified by:

getId in interface ClassBasic

getName

public java.lang.String getName()

actual value of name-attribute

Specified by:

getName in interface Basic

setNameAttribute

public void setNameAttribute(java.lang.String name,
                             long time)
                      throws ModelException

set a new key of name-attribute This seted attribute is used as name attribute.

Parameters:

name - new key of name-attribute

time - time of setting

Throws:

ModelException

getNameAttribute

public java.util.List<Attribute> getNameAttribute()

get vector with all historical name-keys

Returns:

vector with all historical name-keys

getPriority

public int getPriority()

get actual value of priority-attribute

Returns:

actual value of priority-attribute

setPriorityAttribute

public void setPriorityAttribute(java.lang.String p,
                                 long time)
                          throws ModelException

sets new value of priority-attribute

Parameters:

p - new priority-value

time - time of setting

Throws:

ModelException

getPriorityAttribute

public java.util.List<Attribute> getPriorityAttribute()

get historical vector of priorities

Returns:

historical vector of priorities

getVelocity

public double getVelocity()

get actual velocity

Returns:

actual velocity

setVelocityAttribute

public void setVelocityAttribute(java.lang.String v,
                                 long time)
                          throws ModelException

set new value of velocity-attribute

Parameters:

v - new value of velocity

time - time of setting

Throws:

ModelException

getVelocityAttribute

public java.util.List<Attribute> getVelocityAttribute()

get historical vector of velocity

Returns:

historical vector of velocity

getEntityTypeId

public java.lang.String getEntityTypeId()

setState

public void setState(java.lang.String state,
                     long time)
              throws ModelException

set new state-value

Parameters:

state - new state-value

time - time of setting

Throws:

ModelException

getState

public java.lang.String getState()

get actual value of state

Returns:

actual value of state

getStateHistory

public java.util.List<Attribute> getStateHistory()

get vector of state history

Returns:

vector of state history

changeContainer

public void changeContainer(java.lang.String type,
                            java.lang.String id,
                            java.lang.String op,
                            long time)
                     throws ModelException

An entity will be created, add or remove a container. This history is stored in containerHistory

Parameters:

type - container-typ (route, list, ..)

id - container-id or "free" or "static"

op - add or remove or created or destroyed

time - time of operation

Throws:

ModelException, - when type or id contains a Cmd.VALUE_SEPARATOR

ModelException

getContainerHistory

public java.util.List<Attribute> getContainerHistory()

get vector of containerHistory

Returns:

vector of containerHistory

isFree

public boolean isFree()

An entity is static or it is in a container (list, route, process) or it is free Only a free entity can put in to a container

Returns:

true, when non-static entity is in no container

isStatic

public boolean isStatic()

An entity has a fixed location

Returns:

true, when entity has a fixed location

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.String value,
                         long since)

set an attribute-value

Parameters:

key - attribute-key

value - attribute-value

since - time of setting

getAttribute

public java.lang.String getAttribute(java.lang.String key)

get actual value of attribute

Parameters:

key - attribute-key

Returns:

actual value of attribute

getAttributeHistory

public java.util.List<Attribute> getAttributeHistory(java.lang.String key)

get history vector of attribute

Parameters:

key - attribute-key

Returns:

history vector of attribute

existAttribute

public boolean existAttribute(java.lang.String key)

check if attribute-key is valid

Parameters:

key -

Returns:

true, when attribute-key is valid

dispose

public void dispose()

Dispose this entity

createGraficFree

public Grafic createGraficFree(long time)
                        throws ModelException

creates an EntityGrafic instance for an free entity

Parameters:

time - time of creation

Returns:

EntityGrafic

Throws:

ModelException

createGraficStatic

public Grafic createGraficStatic(java.lang.String viewId,
                                 double positionX,
                                 double positionY,
                                 double angle,
                                 boolean direction,
                                 long time)
                          throws ModelException

creates an EntityGrafic instance for an static entity with fixed position

Parameters:

viewId - Id of view

positionY - y-coordinate

angle - Drehwinkel

direction - icon ist an y-achse gespiegelt

time - time of creation

Returns:

EntityGrafic

Throws:

ModelException

getGrafic

public Grafic getGrafic()

Specified by:

getGrafic in interface Basic