com.anylogic.engine

Class ExtEntityContinuousDelegate<E extends ExtEntity>

java.lang.Object

com.anylogic.engine.AgentExtensionImpl

com.anylogic.engine.ExtAgentContinuousDelegate<ExtAgentContinuous>

com.anylogic.engine.ExtEntityContinuousDelegate<E>

Type Parameters:

E - type of agent extension to delegate to. If you are creating new extension based on 'Entity', please set the type to ExtEntity

All Implemented Interfaces:

AgentExtension, ExtAgentContinuous, ExtAgentInteractive, ExtAgentWithSpatialMetrics, ExtAnimationParams, ExtDefaultAnimationProvider, ExtEntity, ExtWithSpaceType, java.io.Serializable

Deprecated.

@Deprecated
 @AnyLogicInternalAPI
public abstract class ExtEntityContinuousDelegate<E extends ExtEntity>
extends ExtAgentContinuousDelegate<ExtAgentContinuous>
implements ExtEntity

Base class for extensions delegating their 'Entity' activity to an existing extension of agent

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ExtEntity	ee Deprecated.

Fields inherited from class com.anylogic.engine.ExtAgentContinuousDelegate

e

Fields inherited from interface com.anylogic.engine.AgentExtension

P_AGENT_INTERACTIVE_DELEGATE, P_AGENT_WITH_SPATIAL_METRICS_DELEGATE, P_AGENT_WITH_SPECIFIC_SPACE, P_AGENT_WITH_SPECIFIC_SPACE_DELEGATE, P_ENTITY_DELEGATE, P_ENV_WITH_SPECIFIC_SPACE, P_ROOT, P_SPACE, P_USER_EXT

Constructor Summary

Constructors

Constructor and Description
ExtEntityContinuousDelegate(Agent owner) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addAgentToContents(Agent entity) Deprecated. Adds a given agent to the contents of this agent.
<T extends Agent> java.util.List<T>	agentsInRange(java.lang.Iterable<T> agents, double distance) Deprecated. Returns the unsorted list of agents from the given collection which are within the given distance from this agent
<T extends Agent> java.util.List<T>	agentsInRange(java.lang.Iterable<T> agents, double distance, LengthUnits units) Deprecated. Returns the unsorted list of agents from the given collection which are within the given distance from this agent
java.util.List<Agent>	contents() Deprecated.
ShapeTopLevelPresentationGroup	createDefaultAnimation() Deprecated.
FlowchartBlock	currentBlock() Deprecated. Returns the current flowchart block this agent is being processed in.
void	destroyEntity() Deprecated. Destroys the agent.
double	distanceTo(Agent other) Deprecated. Calculates the distance from this agent to another one in continuous 3D space.
double	distanceTo(Agent other, LengthUnits units) Deprecated. Calculates the distance from this agent to another one.
double	distanceTo(double x, double y) Deprecated. Calculates the distance from this agent to a given point in the projection to the horizontal plane (i.e. agent's Z coordinate isn't used in the calculation).
double	distanceTo(double x, double y, LengthUnits units) Deprecated. Calculates the distance from this agent to a given point in the projection to the horizontal plane (i.e. agent's Z coordinate isn't used in the calculation).
double	distanceTo(Point point) Deprecated. Calculates the distance from this agent to the point.
double	distanceTo(Point point, LengthUnits units) Deprecated. Calculates the distance from this agent to the point.
Position	getAnimationPosition(Position out) Deprecated.
double	getAnimationX() Deprecated.
double	getAnimationY() Deprecated.
double	getAnimationZ() Deprecated.
double	getBlockEnterTime() Deprecated. Returns the time this agent entered its current flowchart block.
java.awt.Color	getColor() Deprecated. Returns the color of the item default shape.
ShapeTopLevelPresentationGroup	getDefaultAnimation() Deprecated.
double	getFlowchartEntryTime() Deprecated. Returns the time the agent has entered the first block in the flowchart, or Double.NaN if this agent hasn't yet visited any flowchart
double	getHeight() Deprecated. Returns the height of the agent - used by conveyors and other blocks which require it during processing.
double	getHeight(LengthUnits units) Deprecated. Returns the height of the agent - used by conveyors and other blocks which require it during processing.
int	getId() Deprecated. Returns Id of agent.
double	getLength() Deprecated. Returns the length of the agent - used by conveyors and other blocks which require it during processing.
double	getLength(LengthUnits units) Deprecated. Returns the length of the agent - used by conveyors and other blocks which require it during processing.
<T extends Agent> T	getNearestAgent(java.lang.Iterable<T> agents) Deprecated. Returns the nearest agent from the given collection
INetwork	getNetwork() Deprecated. Returns the network this agent lives in, actual for agents in continuous space.
INode	getNetworkNode() Deprecated. Returns the network node this agent currently is located in, actual for agents in continuous space.
double	getPresentationScaleOnOwnerSpace() Deprecated. Returns the scale of the agent presentation animation on its space or 1.0 if space isn't defined or agent list is empty
Agent	getSpace() Deprecated. Returns the agent representing space this agent lives in
SpaceType	getSpaceType() Deprecated. Returns the type of space this agent lives in, one of SPACE_CONTINUOUS, SPACE_DISCRETE, SPACE_GIS, SPACE_NONE
double	getSpeed() Deprecated. Returns the current value of the agent speed (measured in m/s).
double	getSpeed(SpeedUnits units) Deprecated. Returns the current value of the agent speed in continuous space.
double	getTargetX() Deprecated. Returns the x of the target location if moving, otherwise current x in continuous space.
double	getTargetY() Deprecated. Returns the y of the target location if moving, otherwise current y in continuous space.
double	getVelocity() Deprecated. Returns the current value of the agent speed in continuous space.
double	getWidth() Deprecated. Returns the width of the agent - used by conveyors and other blocks which require it during processing.
double	getWidth(LengthUnits units) Deprecated. Returns the width of the agent - used by conveyors and other blocks which require it during processing.
void	highlight(boolean yes) Deprecated. Turns on/off highlighting of this agent animation.
boolean	isAnimationVisible_xjal() Deprecated.
boolean	isAutomaticHorizontalRotation() Deprecated. Returns true if agent is set to be rotated (in horizontal plane) during movement, false otherwise
boolean	isMoving() Deprecated. Tests if the agent is currently moving.
void	jumpTo(double x, double y) Deprecated. Instantly moves the agent to a given location (without changes to Z-coordinate, if any).
void	jumpTo(INode node, Point location) Deprecated. Instantly moves the agent to a given network location.
void	jumpTo(Point location) Deprecated. Instantly moves the agent to a given location.
void	moveTo(double x, double y) Deprecated. Starts movement in the direction of the given target location.
void	moveTo(INode node, Point location) Deprecated. Starts movement to the given network node.
void	moveTo(Point location) Deprecated. Starts movement in the direction of the given target location.
void	moveToInTime(double x, double y, double tripTime) Deprecated. Starts movement in the direction of the given target location.
void	moveToInTime(double x, double y, double tripTime, TimeUnits units) Deprecated. Starts movement in the direction of the given target location.
void	moveToInTime(INode node, Point location, double tripTime) Deprecated. Starts movement to the given network node.
void	moveToInTime(INode node, Point location, double tripTime, TimeUnits units) Deprecated. Starts movement to the given network node.
void	moveToInTime(Point location, double tripTime) Deprecated. Starts movement in the direction of the given target location.
void	moveToInTime(Point location, double tripTime, TimeUnits units) Deprecated. Starts movement in the direction of the given target location.
void	moveToNearestAgent(java.lang.Iterable<? extends Agent> agents) Deprecated. Starts movement to the nearest agent from the given collection.
void	moveToNearestAgent(java.lang.Iterable<? extends Agent> agents, double tripTime) Deprecated. Starts movement to the nearest agent from the given collection.
void	moveToStraight(Point location) Deprecated. Starts straight movement in the direction of the given target location.
void	moveToStraightInTime(Point location, double tripTime) Deprecated. Starts straight movement in the direction of the given target location.
void	moveToStraightInTime(Point location, double tripTime, TimeUnits units) Deprecated. Starts straight movement in the direction of the given target location.
boolean	onClick() Deprecated. Should be overridden to define the reaction on mouse click.
int	priority() Deprecated. This method is internal and shouldn't be called by user.
boolean	removeAgentFromContents(Agent entity) Deprecated. Removes the given agent from the contents of this agent.
Agent	resourceUnitOfPool(Agent pool) Deprecated. Returns the first occurrence of resource unit of a given pool among the seized resource units, or null if not found.
java.util.List<Agent>	resourceUnits() Deprecated. Returns the list of resource units seized by the agent, or empty list if there are none.
java.util.List<Agent>	resourceUnitsOfPool(Agent pool) Deprecated. Returns resource units currently seized by this agent from the given ResourcePool block
java.util.List<Agent>	resourceUnitsOfSeize(Agent seize) Deprecated. Return resource units currently seized by this agent in the given Seize block
void	setArrivalCallback(ArrivalCallback arrivalCallback) Deprecated. This method is designed for advanced users and library developers, for general purpose arrival processing please use "On arrival" action which can be found on the properties of Agent Type.
void	setAutomaticHorizontalRotation(boolean yes) Deprecated. Tells agent to rotate automatically (in horizontal plane) during movements.
void	setColor(java.awt.Color color) Deprecated. Sets the color of the item default shape.
void	setFlowchartActivityType(FlowchartActivityType activityType, FlowchartBlock block) Deprecated. Sets activity type info (used in e.g. logging to DB) for the given entity
void	setHeight(double height) Deprecated. Sets the height of the agent (in meters)
void	setHeight(double height, LengthUnits units) Deprecated. Sets the height of the agent in the given units
void	setLength(double length) Deprecated. Sets the length of the agent (in meters)
void	setLength(double length, LengthUnits units) Deprecated. Sets the length of the agent in the given units
void	setNetwork(INetwork network) Deprecated. Sets this agent to live in the network, actual for agents in continuous space.
void	setNetworkInternal(INetwork network, INode node, Position location) Deprecated.
void	setNetworkNode(INode node) Deprecated. Sets the current network location for the agent
void	setNetworkNode(INode node, Point position) Deprecated. Sets the current network location for the agent
void	setSpace(Agent space) Deprecated. Sets the space for agent.
void	setSpeed(double speedInMPS) Deprecated. Changes speed of the agent (measured in m/s).
void	setSpeed(double s, SpeedUnits units) Deprecated. Changes speed of the agent in continuous space (measured in the given units).
void	setVelocity(double v) Deprecated. Changes speed of the agent in continuous space (measured in pixels per model-time-unit).
void	setWidth(double width) Deprecated. Sets the width of the agent (in meters)
void	setWidth(double width, LengthUnits units) Deprecated. Sets the width of the agent in the given units
void	stop() Deprecated. Stops movement, if any.
double	timeToArrival() Deprecated. Returns the time to arrival to the target location in continuous space, in model-time units.
double	timeToArrival(TimeUnits units) Deprecated. Returns the time to arrival to the target location, in time units.
void	updatePosition() Deprecated. Updates agent coordinates

Methods inherited from class com.anylogic.engine.ExtAgentContinuousDelegate

addConnection_xjal, agentInfo, connectTo, copyToAndDestroyOnSpaceTypeChange_xjal, deliver, deliver, disconnectFrom, disconnectFromAll, distanceTo, distanceTo, distanceToSq, distanceToSq, distanceToSq, getConnectedAgent, getConnections, getConnectionsNumber, getEnvironment, getLevel, getRandomConnectedAgent, getRouteProvider, getTargetZ, isAutomaticVerticalRotation, isConnectedTo, jumpTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToStraight, moveToStraightInTime, moveToStraightInTime, receive, removeConnection_xjal, restoreConnections_xjal, send, send, setAutomaticVerticalRotation, setEnvironment_xjal, setLevel, setNetworkNode, setRouteProvider

Methods inherited from class com.anylogic.engine.AgentExtensionImpl

error, error, getAgent, getSupportedInterfaces_xjal, next_xjal, onDestroy, onExtensionRemoved, setNext_xjal, supportsInterface_xjal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.anylogic.engine.ExtAgentWithSpatialMetrics

getLevel, getRouteProvider, setLevel, setRouteProvider

Methods inherited from interface com.anylogic.engine.AgentExtension

getAgent, next_xjal, onDestroy, onExtensionRemoved, setNext_xjal, supportsInterface_xjal

Field Detail

ee

public final ExtEntity ee

Deprecated.

Constructor Detail

ExtEntityContinuousDelegate

@Deprecated
public ExtEntityContinuousDelegate(Agent owner)

Deprecated.

Method Detail

destroyEntity

@AnyLogicInternalAPI
public void destroyEntity()

Deprecated.

Description copied from interface: ExtEntity

Destroys the agent.

Specified by:

destroyEntity in interface ExtEntity

highlight

public void highlight(boolean yes)

Deprecated.

Description copied from interface: ExtEntity

Turns on/off highlighting of this agent animation. The behavior of the function is specific for different agent types and usually depends on the library which drives this agent

Specified by:

highlight in interface ExtEntity

getId

public int getId()

Deprecated.

Description copied from interface: ExtEntity

Returns Id of agent. This method is designed only for debug purposes. It doesn't guarantees that id is unique.
Note that when the model produces more than ~billion agents then there may be agents with negative and even equal ids.

Specified by:

getId in interface ExtEntity

Returns:

Id of agent

getFlowchartEntryTime

public double getFlowchartEntryTime()

Deprecated.

Description copied from interface: ExtEntity

Returns the time the agent has entered the first block in the flowchart, or Double.NaN if this agent hasn't yet visited any flowchart

Specified by:

getFlowchartEntryTime in interface ExtEntity

Returns:

time or Double.NaN

addAgentToContents

public void addAgentToContents(Agent entity)

Deprecated.

Description copied from interface: ExtEntity

Adds a given agent to the contents of this agent.

Specified by:

addAgentToContents in interface ExtEntity

Parameters:

entity - the agent to add

removeAgentFromContents

public boolean removeAgentFromContents(Agent entity)

Deprecated.

Description copied from interface: ExtEntity

Removes the given agent from the contents of this agent.

Specified by:

removeAgentFromContents in interface ExtEntity

Parameters:

entity - the agent to remove

Returns:

returns true if agent was removed, false if this agent didn't contain the specified agent

getLength

public double getLength()

Deprecated.

Description copied from interface: ExtEntity

Returns the length of the agent - used by conveyors and other blocks which require it during processing.

Specified by:

getLength in interface ExtEntity

Returns:

the length of the agent

getLength

public double getLength(LengthUnits units)

Deprecated.

Description copied from interface: ExtEntity

Returns the length of the agent - used by conveyors and other blocks which require it during processing.

Specified by:

getLength in interface ExtEntity

Parameters:

units - units of length to be used

Returns:

the length of the agent

setLength

public void setLength(double length)

Deprecated.

Description copied from interface: ExtEntity

Sets the length of the agent (in meters)

Specified by:

setLength in interface ExtEntity

setLength

public void setLength(double length,
                      LengthUnits units)

Deprecated.

Description copied from interface: ExtEntity

Sets the length of the agent in the given units

Specified by:

setLength in interface ExtEntity

Parameters:

length - the length of the agent

units - units of length to be used

getWidth

public double getWidth()

Deprecated.

Description copied from interface: ExtEntity

Returns the width of the agent - used by conveyors and other blocks which require it during processing.

Specified by:

getWidth in interface ExtEntity

Returns:

the width of the agent

getWidth

public double getWidth(LengthUnits units)

Deprecated.

Description copied from interface: ExtEntity

Returns the width of the agent - used by conveyors and other blocks which require it during processing.

Specified by:

getWidth in interface ExtEntity

Parameters:

units - units of length to be used

Returns:

the width of the agent

setWidth

public void setWidth(double width)

Deprecated.

Description copied from interface: ExtEntity

Sets the width of the agent (in meters)

Specified by:

setWidth in interface ExtEntity

setWidth

public void setWidth(double width,
                     LengthUnits units)

Deprecated.

Description copied from interface: ExtEntity

Sets the width of the agent in the given units

Specified by:

setWidth in interface ExtEntity

Parameters:

width - the width of the agent

units - units of length to be used

getHeight

public double getHeight()

Deprecated.

Description copied from interface: ExtEntity

Returns the height of the agent - used by conveyors and other blocks which require it during processing.

Specified by:

getHeight in interface ExtEntity

Returns:

the height of the agent

getHeight

public double getHeight(LengthUnits units)

Deprecated.

Description copied from interface: ExtEntity

Returns the height of the agent - used by conveyors and other blocks which require it during processing.

Specified by:

getHeight in interface ExtEntity

Parameters:

units - units of length to be used

Returns:

the height of the agent

setHeight

public void setHeight(double height)

Deprecated.

Description copied from interface: ExtEntity

Sets the height of the agent (in meters)

Specified by:

setHeight in interface ExtEntity

setHeight

public void setHeight(double height,
                      LengthUnits units)

Deprecated.

Description copied from interface: ExtEntity

Sets the height of the agent in the given units

Specified by:

setHeight in interface ExtEntity

Parameters:

height - the height of the agent

units - units of length to be used

contents

public java.util.List<Agent> contents()

Deprecated.

Specified by:

contents in interface ExtEntity

resourceUnits

public java.util.List<Agent> resourceUnits()

Deprecated.

Description copied from interface: ExtEntity

Returns the list of resource units seized by the agent, or empty list if there are none.

Specified by:

resourceUnits in interface ExtEntity

Returns:

the list of resource units seized by the agent, never returns null

resourceUnitsOfSeize

public java.util.List<Agent> resourceUnitsOfSeize(Agent seize)

Deprecated.

Description copied from interface: ExtEntity

Return resource units currently seized by this agent in the given Seize block

Specified by:

resourceUnitsOfSeize in interface ExtEntity

Parameters:

seize - Seize block

Returns:

resource units currently seized by this agent

resourceUnitsOfPool

public java.util.List<Agent> resourceUnitsOfPool(Agent pool)

Deprecated.

Description copied from interface: ExtEntity

Returns resource units currently seized by this agent from the given ResourcePool block

Specified by:

resourceUnitsOfPool in interface ExtEntity

Parameters:

pool - ResourcePool block

Returns:

resource units currently seized by this agent

resourceUnitOfPool

public Agent resourceUnitOfPool(Agent pool)

Deprecated.

Description copied from interface: ExtEntity

Returns the first occurrence of resource unit of a given pool among the seized resource units, or null if not found.

Specified by:

resourceUnitOfPool in interface ExtEntity

Parameters:

pool - the pool of the unit (ResourcePool block)

Returns:

the seized resource unit from the given pool, if found

currentBlock

public FlowchartBlock currentBlock()

Deprecated.

Description copied from interface: ExtEntity

Returns the current flowchart block this agent is being processed in. This method is designed for agents which act as 'entities' in process flowchart diagrams.

Specified by:

currentBlock in interface ExtEntity

Returns:

the current flowchart block containing this agent or null if the agent isn't in flowchart

getBlockEnterTime

public double getBlockEnterTime()

Deprecated.

Description copied from interface: ExtEntity

Returns the time this agent entered its current flowchart block.

Specified by:

getBlockEnterTime in interface ExtEntity

Returns:

the time this agent entered its current flowchart block or Double.NaN if this agent isn't in the flowchart

setColor

public void setColor(java.awt.Color color)

Deprecated.

Description copied from interface: ExtEntity

Sets the color of the item default shape.

Specified by:

setColor in interface ExtEntity

Parameters:

color - the new color of the default shape

getColor

public java.awt.Color getColor()

Deprecated.

Description copied from interface: ExtEntity

Returns the color of the item default shape.

Specified by:

getColor in interface ExtEntity

Returns:

the color of the item default shape

getDefaultAnimation

public ShapeTopLevelPresentationGroup getDefaultAnimation()

Deprecated.

Specified by:

getDefaultAnimation in interface ExtDefaultAnimationProvider

createDefaultAnimation

@AnyLogicInternalAPI
public ShapeTopLevelPresentationGroup createDefaultAnimation()

Deprecated.

Specified by:

createDefaultAnimation in interface ExtDefaultAnimationProvider

onClick

@AnyLogicInternalAPI
public boolean onClick()

Deprecated.

Description copied from interface: ExtDefaultAnimationProvider

Should be overridden to define the reaction on mouse click.

Specified by:

onClick in interface ExtDefaultAnimationProvider

Returns:

always return false here.

priority

public int priority()

Deprecated.

Description copied from interface: AgentExtension

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
This function is used for sorting extensions (in order for the overriding delegation to work)

Specified by:

priority in interface AgentExtension

Overrides:

priority in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

int value, see also P_* constants

setSpace

public void setSpace(Agent space)

Deprecated.

Description copied from interface: ExtAnimationParams

Sets the space for agent. Shouldn't be called for moving agents. Coordinates and rotations are left "as is"

Specified by:

setSpace in interface ExtAnimationParams

Overrides:

setSpace in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

space - the agent representing space this agent will live in

stop

public void stop()

Deprecated.

Description copied from interface: ExtAgentContinuous

Stops movement, if any.

Specified by:

stop in interface ExtAgentContinuous

Specified by:

stop in interface ExtAgentWithSpatialMetrics

Overrides:

stop in class ExtAgentContinuousDelegate<ExtAgentContinuous>

moveTo

public void moveTo(double x,
                   double y)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement in the direction of the given target location. Z coordinate of target is the same as the current agent's Z coordinate.
"On arrival" code is executed when movement is finished.

Specified by:

moveTo in interface ExtAgentWithSpatialMetrics

Overrides:

moveTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

x - the x coordinate of the target location

y - the y coordinate of the target location

getSpace

public Agent getSpace()

Deprecated.

Description copied from interface: ExtAnimationParams

Returns the agent representing space this agent lives in

Specified by:

getSpace in interface ExtAnimationParams

Overrides:

getSpace in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the agent representing space this agent lives in

getAnimationX

public double getAnimationX()

Deprecated.

Specified by:

getAnimationX in interface ExtAnimationParams

Overrides:

getAnimationX in class ExtAgentContinuousDelegate<ExtAgentContinuous>

getAnimationY

public double getAnimationY()

Deprecated.

Specified by:

getAnimationY in interface ExtAnimationParams

Overrides:

getAnimationY in class ExtAgentContinuousDelegate<ExtAgentContinuous>

getAnimationZ

public double getAnimationZ()

Deprecated.

Specified by:

getAnimationZ in interface ExtAnimationParams

Overrides:

getAnimationZ in class ExtAgentContinuousDelegate<ExtAgentContinuous>

getAnimationPosition

public Position getAnimationPosition(Position out)

Deprecated.

Specified by:

getAnimationPosition in interface ExtAnimationParams

Overrides:

getAnimationPosition in class ExtAgentContinuousDelegate<ExtAgentContinuous>

getPresentationScaleOnOwnerSpace

public double getPresentationScaleOnOwnerSpace()

Deprecated.

Description copied from interface: ExtAnimationParams

Returns the scale of the agent presentation animation on its space or 1.0 if space isn't defined or agent list is empty

Specified by:

getPresentationScaleOnOwnerSpace in interface ExtAnimationParams

Overrides:

getPresentationScaleOnOwnerSpace in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the scale of presentation animation on owner space

moveTo

public void moveTo(Point location)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement in the direction of the given target location.
"On arrival" code is executed when movement is finished.

Specified by:

moveTo in interface ExtAgentWithSpatialMetrics

Overrides:

moveTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

location - the target location

moveToInTime

public void moveToInTime(Point location,
                         double tripTime)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement in the direction of the given target location.
Changes the speed of the agent in order to reach target in tripTime model time units.
"On arrival" code is executed when movement is finished.

Specified by:

moveToInTime in interface ExtAgentWithSpatialMetrics

Overrides:

moveToInTime in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

location - the target location

tripTime - the time of the movement trip

isAnimationVisible_xjal

public boolean isAnimationVisible_xjal()

Deprecated.

Specified by:

isAnimationVisible_xjal in interface ExtAnimationParams

Overrides:

isAnimationVisible_xjal in class ExtAgentContinuousDelegate<ExtAgentContinuous>

moveToInTime

public void moveToInTime(Point location,
                         double tripTime,
                         TimeUnits units)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement in the direction of the given target location.
Changes the speed of the agent in order to reach target in tripTime model time units.
"On arrival" code is executed when movement is finished.

Specified by:

moveToInTime in interface ExtAgentWithSpatialMetrics

Overrides:

moveToInTime in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

location - the target location

tripTime - the time of the movement trip

units - the time units

moveToStraight

public void moveToStraight(Point location)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts straight movement in the direction of the given target location.
"On arrival" code is executed when movement is finished.

Specified by:

moveToStraight in interface ExtAgentWithSpatialMetrics

Overrides:

moveToStraight in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

location - the target location

moveToStraightInTime

public void moveToStraightInTime(Point location,
                                 double tripTime)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts straight movement in the direction of the given target location.
Changes the speed of the agent in order to reach target in tripTime model time units.
"On arrival" code is executed when movement is finished.

Specified by:

moveToStraightInTime in interface ExtAgentWithSpatialMetrics

Overrides:

moveToStraightInTime in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

location - the target location

tripTime - the time of the movement trip

moveToStraightInTime

public void moveToStraightInTime(Point location,
                                 double tripTime,
                                 TimeUnits units)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts straight movement in the direction of the given target location.
Changes the speed of the agent in order to reach target in tripTime model time units.
"On arrival" code is executed when movement is finished.

Specified by:

moveToStraightInTime in interface ExtAgentWithSpatialMetrics

Overrides:

moveToStraightInTime in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

location - the target location

tripTime - the time of the movement trip

units - the time units

moveTo

public void moveTo(INode node,
                   Point location)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement to the given network node.
"On arrival" code is executed when movement is finished.

Specified by:

moveTo in interface ExtAgentWithSpatialMetrics

Overrides:

moveTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

node - the network node.

location - (optional) location within node, may be null

moveToInTime

public void moveToInTime(double x,
                         double y,
                         double tripTime)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement in the direction of the given target location. (in case of 3D space, Z coordinate of target is the same as the current agent's Z coordinate.
"On arrival" code is executed when movement is finished.
The exact behavior of this method depends on the underlying space type.

Specified by:

moveToInTime in interface ExtAgentWithSpatialMetrics

Overrides:

moveToInTime in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

x - the x coordinate of the target location

y - the y coordinate of the target location

tripTime - the time of the movement trip

moveToInTime

public void moveToInTime(double x,
                         double y,
                         double tripTime,
                         TimeUnits units)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement in the direction of the given target location. (in case of 3D space, Z coordinate of target is the same as the current agent's Z coordinate.
"On arrival" code is executed when movement is finished.
The exact behavior of this method depends on the underlying space type.

Specified by:

moveToInTime in interface ExtAgentWithSpatialMetrics

Overrides:

moveToInTime in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

x - the x coordinate of the target location

y - the y coordinate of the target location

tripTime - the time of the movement trip

units - the time units

moveToInTime

public void moveToInTime(INode node,
                         Point location,
                         double tripTime)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement to the given network node.
Changes the speed of the agent in order to reach target in tripTime model time units.
"On arrival" code is executed when movement is finished.

Specified by:

moveToInTime in interface ExtAgentWithSpatialMetrics

Overrides:

moveToInTime in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

node - the network node.

location - (optional) location within node, may be null

tripTime - the time of the movement trip

moveToInTime

public void moveToInTime(INode node,
                         Point location,
                         double tripTime,
                         TimeUnits units)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement to the given network node.
Changes the speed of the agent in order to reach target in tripTime model time units.
"On arrival" code is executed when movement is finished.

Specified by:

moveToInTime in interface ExtAgentWithSpatialMetrics

Overrides:

moveToInTime in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

node - the network node.

location - (optional) location within node, may be null

tripTime - the time of the movement trip

units - the time units

jumpTo

public void jumpTo(double x,
                   double y)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Instantly moves the agent to a given location (without changes to Z-coordinate, if any). Terminates any movement.
The exact behavior of this method depends on the underlying space type.
Doesn't call "on arrival" code

Specified by:

jumpTo in interface ExtAgentWithSpatialMetrics

Overrides:

jumpTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

x - the x coordinate of the new location

y - the y coordinate of the new location

jumpTo

public void jumpTo(Point location)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Instantly moves the agent to a given location. Terminates any movement.
Doesn't call "on arrival" code

Specified by:

jumpTo in interface ExtAgentWithSpatialMetrics

Overrides:

jumpTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

location - the new location

jumpTo

public void jumpTo(INode node,
                   Point location)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Instantly moves the agent to a given network location. Terminates any movement.
Doesn't call "on arrival" code

Specified by:

jumpTo in interface ExtAgentWithSpatialMetrics

Overrides:

jumpTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

node - the network node.

location - (optional) location within node, may be null

setArrivalCallback

public void setArrivalCallback(ArrivalCallback arrivalCallback)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

This method is designed for advanced users and library developers, for general purpose arrival processing please use "On arrival" action which can be found on the properties of Agent Type.
Sets the listener which will be notified when the agent arrives (onArrival) or when the agent movement is cancelled or redirected (onCancel). The agent should be stopped at the time this method is called and should have no arrival callback set, otherwise this method will throw an error.
The arrival callback is automatically forgotten once notified.

Specified by:

setArrivalCallback in interface ExtAgentWithSpatialMetrics

Overrides:

setArrivalCallback in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

arrivalCallback - the listener which will be notified about agent's arrival

moveToNearestAgent

public void moveToNearestAgent(java.lang.Iterable<? extends Agent> agents)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement to the nearest agent from the given collection. Stops any current movement.

Specified by:

moveToNearestAgent in interface ExtAgentWithSpatialMetrics

Overrides:

moveToNearestAgent in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

agents - the collection of agents

moveToNearestAgent

public void moveToNearestAgent(java.lang.Iterable<? extends Agent> agents,
                               double tripTime)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Starts movement to the nearest agent from the given collection. Stops any current movement.
Changes the speed of the agent in order to reach target in tripTime model time units.

Specified by:

moveToNearestAgent in interface ExtAgentWithSpatialMetrics

Overrides:

moveToNearestAgent in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

agents - the collection of agents

tripTime - the time of the movement trip

getNearestAgent

public <T extends Agent> T getNearestAgent(java.lang.Iterable<T> agents)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Returns the nearest agent from the given collection

Specified by:

getNearestAgent in interface ExtAgentWithSpatialMetrics

Overrides:

getNearestAgent in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

agents - the collection of agents

Returns:

the nearest agent (never this one) or null if the collection is empty

agentsInRange

public <T extends Agent> java.util.List<T> agentsInRange(java.lang.Iterable<T> agents,
                                                         double distance)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Returns the unsorted list of agents from the given collection which are within the given distance from this agent

Specified by:

agentsInRange in interface ExtAgentWithSpatialMetrics

Overrides:

agentsInRange in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

agents - the collection of agents

Returns:

the list of agents within the given distance, unsorted

agentsInRange

public <T extends Agent> java.util.List<T> agentsInRange(java.lang.Iterable<T> agents,
                                                         double distance,
                                                         LengthUnits units)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Returns the unsorted list of agents from the given collection which are within the given distance from this agent

Specified by:

agentsInRange in interface ExtAgentWithSpatialMetrics

Overrides:

agentsInRange in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

agents - the collection of agents

Returns:

the list of agents within the given distance, unsorted

setAutomaticHorizontalRotation

public void setAutomaticHorizontalRotation(boolean yes)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Tells agent to rotate automatically (in horizontal plane) during movements.

Specified by:

setAutomaticHorizontalRotation in interface ExtAgentWithSpatialMetrics

Overrides:

setAutomaticHorizontalRotation in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

yes - true - agent will be rotated during movement, false - rotation will not be changed

See Also:

#setRotation(double)

isAutomaticHorizontalRotation

public boolean isAutomaticHorizontalRotation()

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Returns true if agent is set to be rotated (in horizontal plane) during movement, false otherwise

Specified by:

isAutomaticHorizontalRotation in interface ExtAgentWithSpatialMetrics

Overrides:

isAutomaticHorizontalRotation in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

true if agent is set to be rotated during movement

See Also:

ExtAgentWithSpatialMetrics.setAutomaticHorizontalRotation(boolean)

getTargetX

public double getTargetX()

Deprecated.

Description copied from interface: ExtAgentContinuous

Returns the x of the target location if moving, otherwise current x in continuous space.

Specified by:

getTargetX in interface ExtAgentContinuous

Specified by:

getTargetX in interface ExtAgentWithSpatialMetrics

Overrides:

getTargetX in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the x of the target location if moving, otherwise current x

getTargetY

public double getTargetY()

Deprecated.

Description copied from interface: ExtAgentContinuous

Returns the y of the target location if moving, otherwise current y in continuous space.

Specified by:

getTargetY in interface ExtAgentContinuous

Specified by:

getTargetY in interface ExtAgentWithSpatialMetrics

Overrides:

getTargetY in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the y of the target location if moving, otherwise current y

distanceTo

public double distanceTo(Agent other)

Deprecated.

Description copied from interface: ExtAgentContinuous

Calculates the distance from this agent to another one in continuous 3D space.

Specified by:

distanceTo in interface ExtAgentContinuous

Specified by:

distanceTo in interface ExtAgentWithSpatialMetrics

Overrides:

distanceTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

other - another agent

Returns:

the distance to the other agent (in pixels)

distanceTo

public double distanceTo(Agent other,
                         LengthUnits units)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Calculates the distance from this agent to another one.
The exact behavior of this method depends on the underlying space type.

Specified by:

distanceTo in interface ExtAgentWithSpatialMetrics

Overrides:

distanceTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

other - another agent

units - the units of length

Returns:

the distance to the other agent

distanceTo

public double distanceTo(Point point)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Calculates the distance from this agent to the point.
The exact behavior of this method depends on the underlying space type.

Specified by:

distanceTo in interface ExtAgentWithSpatialMetrics

Overrides:

distanceTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the distance to the point

distanceTo

public double distanceTo(Point point,
                         LengthUnits units)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Calculates the distance from this agent to the point.
The exact behavior of this method depends on the underlying space type.

Specified by:

distanceTo in interface ExtAgentWithSpatialMetrics

Overrides:

distanceTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

units - the units of length

Returns:

the distance to the point

distanceTo

public double distanceTo(double x,
                         double y)

Deprecated.

Description copied from interface: ExtAgentContinuous

Calculates the distance from this agent to a given point in the projection to the horizontal plane (i.e. agent's Z coordinate isn't used in the calculation).

Specified by:

distanceTo in interface ExtAgentContinuous

Specified by:

distanceTo in interface ExtAgentWithSpatialMetrics

Overrides:

distanceTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

x - the x coordinate of the point

y - the y coordinate of the point

Returns:

the distance of Agent's projection (on the plane Z=0) to the point (x,y) (in pixels)

distanceTo

public double distanceTo(double x,
                         double y,
                         LengthUnits units)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Calculates the distance from this agent to a given point in the projection to the horizontal plane (i.e. agent's Z coordinate isn't used in the calculation).

Specified by:

distanceTo in interface ExtAgentWithSpatialMetrics

Overrides:

distanceTo in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

x - the x coordinate of the point

y - the y coordinate of the point

units - the units of lengths

Returns:

the distance of Agent's projection (on the plane Z=0) to the point (x,y)

isMoving

public boolean isMoving()

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Tests if the agent is currently moving.

Specified by:

isMoving in interface ExtAgentWithSpatialMetrics

Overrides:

isMoving in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

true if the agent is moving, false otherwise

setVelocity

public void setVelocity(double v)

Deprecated.

Description copied from interface: ExtAgentContinuous

Changes speed of the agent in continuous space (measured in pixels per model-time-unit).
If the agent is moving, it continues moving with the new speed. Note that nonzero speed does not mean the agent is moving - it starts moving only after moveTo() is called.

Specified by:

setVelocity in interface ExtAgentContinuous

Specified by:

setVelocity in interface ExtAgentWithSpatialMetrics

Overrides:

setVelocity in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

v - the new speed

getVelocity

public double getVelocity()

Deprecated.

Description copied from interface: ExtAgentContinuous

Returns the current value of the agent speed in continuous space. (measured in pixels per model-time-unit).
Note that nonzero speed does not mean the agent is moving - it starts moving only after moveTo is called.

Specified by:

getVelocity in interface ExtAgentContinuous

Specified by:

getVelocity in interface ExtAgentWithSpatialMetrics

Overrides:

getVelocity in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the current value of agent speed

setSpeed

public void setSpeed(double speedInMPS)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Changes speed of the agent (measured in m/s).
If the agent is moving, it continues moving with the new speed. Note that nonzero speed does not mean the agent is moving - it starts moving only after moveTo() is called.

Specified by:

setSpeed in interface ExtAgentWithSpatialMetrics

Overrides:

setSpeed in class ExtAgentContinuousDelegate<ExtAgentContinuous>

setSpeed

public void setSpeed(double s,
                     SpeedUnits units)

Deprecated.

Description copied from interface: ExtAgentContinuous

Changes speed of the agent in continuous space (measured in the given units).
If the agent is moving, it continues moving with the new speed. Note that nonzero speed does not mean the agent is moving - it starts moving only after moveTo() is called.

Specified by:

setSpeed in interface ExtAgentContinuous

Specified by:

setSpeed in interface ExtAgentWithSpatialMetrics

Overrides:

setSpeed in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

s - the new speed

units - the speed units

getSpeed

public double getSpeed()

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Returns the current value of the agent speed (measured in m/s). The units of the returned value depend on the specific space type.
Note that nonzero speed does not mean the agent is moving - it starts moving only after moveTo is called.

Specified by:

getSpeed in interface ExtAgentWithSpatialMetrics

Overrides:

getSpeed in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the current value of agent speed, meters per second

getSpeed

public double getSpeed(SpeedUnits units)

Deprecated.

Description copied from interface: ExtAgentContinuous

Returns the current value of the agent speed in continuous space. (measured in the given units).
Note that nonzero speed does not mean the agent is moving - it starts moving only after moveTo is called.

Specified by:

getSpeed in interface ExtAgentContinuous

Specified by:

getSpeed in interface ExtAgentWithSpatialMetrics

Overrides:

getSpeed in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

units - the speed units

Returns:

the current value of agent speed

timeToArrival

public double timeToArrival()

Deprecated.

Description copied from interface: ExtAgentContinuous

Returns the time to arrival to the target location in continuous space, in model-time units.
If the agent is not moving, returns 0.

Specified by:

timeToArrival in interface ExtAgentContinuous

Specified by:

timeToArrival in interface ExtAgentWithSpatialMetrics

Overrides:

timeToArrival in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the time to arrival to the target location, or 0

timeToArrival

public double timeToArrival(TimeUnits units)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Returns the time to arrival to the target location, in time units.
If the agent is not moving, returns 0.

Specified by:

timeToArrival in interface ExtAgentWithSpatialMetrics

Overrides:

timeToArrival in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the time to arrival to the target location, or 0

updatePosition

public void updatePosition()

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Updates agent coordinates

Specified by:

updatePosition in interface ExtAgentWithSpatialMetrics

Overrides:

updatePosition in class ExtAgentContinuousDelegate<ExtAgentContinuous>

getNetwork

public INetwork getNetwork()

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Returns the network this agent lives in, actual for agents in continuous space.

Specified by:

getNetwork in interface ExtAgentWithSpatialMetrics

Overrides:

getNetwork in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the network this agent lives in

setNetwork

public void setNetwork(INetwork network)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Sets this agent to live in the network, actual for agents in continuous space.

Specified by:

setNetwork in interface ExtAgentWithSpatialMetrics

Overrides:

setNetwork in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

network - the network this agent will live in

setNetworkInternal

public void setNetworkInternal(INetwork network,
                               INode node,
                               Position location)

Deprecated.

Specified by:

setNetworkInternal in interface ExtAgentWithSpatialMetrics

Overrides:

setNetworkInternal in class ExtAgentContinuousDelegate<ExtAgentContinuous>

getNetworkNode

public INode getNetworkNode()

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Returns the network node this agent currently is located in, actual for agents in continuous space.

Specified by:

getNetworkNode in interface ExtAgentWithSpatialMetrics

Overrides:

getNetworkNode in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

the network node this agent currently is located in

setNetworkNode

public void setNetworkNode(INode node,
                           Point position)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Sets the current network location for the agent

Specified by:

setNetworkNode in interface ExtAgentWithSpatialMetrics

Overrides:

setNetworkNode in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

node - the network node

position - (optional) location within node, may be null

setNetworkNode

public void setNetworkNode(INode node)

Deprecated.

Description copied from interface: ExtAgentWithSpatialMetrics

Sets the current network location for the agent

Specified by:

setNetworkNode in interface ExtAgentWithSpatialMetrics

Overrides:

setNetworkNode in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Parameters:

node - the network node

getSpaceType

public SpaceType getSpaceType()

Deprecated.

Description copied from interface: ExtAgentInteractive

Returns the type of space this agent lives in, one of SPACE_CONTINUOUS, SPACE_DISCRETE, SPACE_GIS, SPACE_NONE

Specified by:

getSpaceType in interface ExtAgentInteractive

Specified by:

getSpaceType in interface ExtAgentWithSpatialMetrics

Overrides:

getSpaceType in class ExtAgentContinuousDelegate<ExtAgentContinuous>

Returns:

one of SPACE_CONTINUOUS, SPACE_DISCRETE, SPACE_GIS, SPACE_NONE

setFlowchartActivityType

public void setFlowchartActivityType(FlowchartActivityType activityType,
                                     FlowchartBlock block)

Deprecated.

Description copied from interface: ExtEntity

Sets activity type info (used in e.g. logging to DB) for the given entity

Specified by:

setFlowchartActivityType in interface ExtEntity

See Also:

FlowchartActivityType