com.anylogic.engine.markup

Class OverheadCrane<T extends Agent>

java.lang.Object

com.anylogic.engine.markup.AbstractMarkup

com.anylogic.engine.markup.MarkupShape

com.anylogic.engine.markup.AbstractLevelMarkup

com.anylogic.engine.markup.Crane<T>

com.anylogic.engine.markup.OverheadCrane<T>

All Implemented Interfaces:

AggregatableAnimationElement, IMarkupLibraryDescriptor, LevelElement, LevelMarkup, com.anylogic.engine.markup.material_handling.IMaterialFallible, com.anylogic.engine.markup.material_handling.IMaterialMarkupLibraryDescriptor, com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T>, SVGElement, java.io.Serializable

public class OverheadCrane<T extends Agent>
extends Crane<T>
implements com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OverheadCrane()
OverheadCrane(Agent owner, ShapeDrawMode drawMode, boolean isPublic, boolean isObstacle, com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T> descriptor, double x, double y, double z, double runwayLengthMeters, double craneWidthMeters, double craneHeightMeters, double bridgeWidthMeters, double bridgeLocationMeters, double trolleyLocationMeters, java.awt.Color color, java.awt.Color trolleyColor, OverheadCraneDrawingType type) This method is internal and shouldn't be called by user.
OverheadCrane(com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T> d)

Method Summary

Modifier and Type	Method and Description
boolean	contains(double px, double py) Test if the shape contains the point with the given coordinates (relative to this shape's container, i.e. in the same system with the coordinates of this shape, x and y)
void	fail()
BoundingRectangle	getBoundingRectangle()
double	getBridgeSpeed(SpeedUnits units)
double	getBridgeWidth()
double	getBridgeWidth(LengthUnits units)
java.awt.Color	getColor() Returns crane's color
double	getCraneHeight() Returns crane height in pixels.
double	getCraneHeight(LengthUnits units) Returns crane height.
double	getCraneWidth()
double	getCraneWidth(LengthUnits units)
Point	getCurrentHookPosition() Returns current hook position in crane's coordinate system.
Point	getInitialHookPoint()
Point	getInitialHookPoint(LengthUnits units)
com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T>	getLibraryDescriptor()
double	getLiftingSpeed(SpeedUnits units)
OverheadCraneMovementMode	getMovementMode()
double	getRotation()
double	getRunwayLength()
double	getRunwayLength(LengthUnits units)
java.awt.Color	getTrolleyColor() Returns color of trolley
double	getTrolleySpeed(SpeedUnits units)
OverheadCraneDrawingType	getType()
double	getUtilization()
boolean	isFailed()
boolean	isReady() Returns true if the crane is ready to work with new agent and false otherwise.
void	onFailed()
void	onLoading(T agent)
void	onRepaired()
void	onUnloading(T agent)
void	repair()
void	resetStats()
void	setBridgeSpeed(double speed, SpeedUnits units)
void	setBridgeWidth(double bridgeWidth, LengthUnits units)
void	setCraneHeight(double craneHeight, LengthUnits units)
void	setCraneWidth(double craneWidth, LengthUnits units)
void	setLiftingSpeed(double speed, SpeedUnits units)
void	setMovementMode(OverheadCraneMovementMode movementMode)
void	setRotation(double rotation)
void	setRunwayLength(double length, LengthUnits units)
void	setTrolleySpeed(double speed, SpeedUnits units)
void	setType(OverheadCraneDrawingType type)
void	updateDynamicProperties() Updates dynamic properties of this shape only (without structural contents, if any) in a given context.

Methods inherited from class com.anylogic.engine.markup.Crane

getX, getXYZ, getY, getZ, notifyDirtyState, setX, setXYZ, setY, setZ

Methods inherited from class com.anylogic.engine.markup.AbstractLevelMarkup

getDrawMode, getLevel, setLevel

Methods inherited from class com.anylogic.engine.markup.MarkupShape

error, getFullName, getPresentable, getSpace, initialize, isClickHandled, isPublic, onClick, remove, setDrawMode, setOwner

Methods inherited from class com.anylogic.engine.markup.AbstractMarkup

discardOwner, executeUserAction, findSVGElement, getName, getSVGId, initializeInternal, isVisible, onAggregatorInitialized, onAggregatorVisibilityChanged, resetSVGState, setVisible, updateDynamicPropertiesStructural, updateSVGProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.anylogic.engine.markup.AggregatableAnimationElement

initializeInternal, onAggregatorVisibilityChanged, postInitialize

Constructor Detail

OverheadCrane

public OverheadCrane()

OverheadCrane

@AnyLogicInternalCodegenAPI
public OverheadCrane(Agent owner,
                                                  ShapeDrawMode drawMode,
                                                  boolean isPublic,
                                                  boolean isObstacle,
                                                  com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T> descriptor,
                                                  double x,
                                                  double y,
                                                  double z,
                                                  double runwayLengthMeters,
                                                  double craneWidthMeters,
                                                  double craneHeightMeters,
                                                  double bridgeWidthMeters,
                                                  double bridgeLocationMeters,
                                                  double trolleyLocationMeters,
                                                  java.awt.Color color,
                                                  java.awt.Color trolleyColor,
                                                  OverheadCraneDrawingType type)

This method is internal and shouldn't be called by user.
it may be removed/renamed in future. It is public due to technical reasons.

OverheadCrane

public OverheadCrane(com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T> d)

Method Detail

onFailed

public void onFailed()

Specified by:

onFailed in interface com.anylogic.engine.markup.material_handling.IMaterialFallible

Specified by:

onFailed in class Crane<T extends Agent>

onRepaired

public void onRepaired()

Specified by:

onRepaired in interface com.anylogic.engine.markup.material_handling.IMaterialFallible

Specified by:

onRepaired in class Crane<T extends Agent>

updateDynamicProperties

@AnyLogicInternalAPI
public void updateDynamicProperties()

Description copied from class: AbstractMarkup

Updates dynamic properties of this shape only (without structural contents, if any) in a given context.
Method should be overridden for shapes with dynamic properties. Note that you should call super.updateDynamicProperties() at the end of overridden method

Overrides:

updateDynamicProperties in class AbstractMarkup

isReady

public boolean isReady()

Description copied from class: Crane

Returns true if the crane is ready to work with new agent and false otherwise.

Specified by:

isReady in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

Specified by:

isReady in class Crane<T extends Agent>

Returns:

true if the crane is ready to work with new agent and false otherwise

onLoading

public void onLoading(T agent)

Specified by:

onLoading in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

Specified by:

onLoading in class Crane<T extends Agent>

onUnloading

public void onUnloading(T agent)

Specified by:

onUnloading in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

Specified by:

onUnloading in class Crane<T extends Agent>

contains

public boolean contains(double px,
                        double py)

Description copied from class: MarkupShape

Test if the shape contains the point with the given coordinates (relative to this shape's container, i.e. in the same system with the coordinates of this shape, x and y)

Specified by:

contains in class MarkupShape

Parameters:

px - the x coordinate relative to this shape's container

py - the y coordinate relative to this shape's container

Returns:

true if the shape contains the point with the given coordinates

isFailed

public boolean isFailed()

Specified by:

isFailed in interface com.anylogic.engine.markup.material_handling.IMaterialFallible

fail

public void fail()

Specified by:

fail in interface com.anylogic.engine.markup.material_handling.IMaterialFallible

repair

public void repair()

Specified by:

repair in interface com.anylogic.engine.markup.material_handling.IMaterialFallible

getLibraryDescriptor

@AnyLogicInternalAPI
public com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T> getLibraryDescriptor()

getTrolleySpeed

public double getTrolleySpeed(SpeedUnits units)

Specified by:

getTrolleySpeed in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

getLiftingSpeed

public double getLiftingSpeed(SpeedUnits units)

Specified by:

getLiftingSpeed in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

getBridgeSpeed

public double getBridgeSpeed(SpeedUnits units)

Specified by:

getBridgeSpeed in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

getMovementMode

public OverheadCraneMovementMode getMovementMode()

Specified by:

getMovementMode in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

getType

public OverheadCraneDrawingType getType()

getColor

public java.awt.Color getColor()

Returns crane's color

Returns:

crane's color

getTrolleyColor

public java.awt.Color getTrolleyColor()

Returns color of trolley

Returns:

color of trolley

setType

public void setType(OverheadCraneDrawingType type)

getRotation

public double getRotation()

getCraneWidth

public double getCraneWidth()

getCraneWidth

public double getCraneWidth(LengthUnits units)

setCraneWidth

public void setCraneWidth(double craneWidth,
                          LengthUnits units)

setCraneHeight

public void setCraneHeight(double craneHeight,
                           LengthUnits units)

getRunwayLength

public double getRunwayLength()

getRunwayLength

public double getRunwayLength(LengthUnits units)

setRunwayLength

public void setRunwayLength(double length,
                            LengthUnits units)

setRotation

public void setRotation(double rotation)

getBridgeWidth

public double getBridgeWidth()

getBridgeWidth

public double getBridgeWidth(LengthUnits units)

setBridgeWidth

public void setBridgeWidth(double bridgeWidth,
                           LengthUnits units)

getInitialHookPoint

@AnyLogicInternalAPI
public Point getInitialHookPoint(LengthUnits units)

getInitialHookPoint

@AnyLogicInternalAPI
public Point getInitialHookPoint()

getCurrentHookPosition

public Point getCurrentHookPosition()

Returns current hook position in crane's coordinate system. Also updates animation.

Specified by:

getCurrentHookPosition in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

Returns:

current hook point in pixels.

setTrolleySpeed

public void setTrolleySpeed(double speed,
                            SpeedUnits units)

Specified by:

setTrolleySpeed in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

setLiftingSpeed

public void setLiftingSpeed(double speed,
                            SpeedUnits units)

Specified by:

setLiftingSpeed in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

setBridgeSpeed

public void setBridgeSpeed(double speed,
                           SpeedUnits units)

Specified by:

setBridgeSpeed in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

setMovementMode

public void setMovementMode(OverheadCraneMovementMode movementMode)

Specified by:

setMovementMode in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

getUtilization

public double getUtilization()

Specified by:

getUtilization in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

resetStats

public void resetStats()

Specified by:

resetStats in interface com.anylogic.engine.markup.material_handling.IOverheadCraneDescriptor<T extends Agent>

getCraneHeight

public double getCraneHeight(LengthUnits units)

Returns crane height.

Parameters:

units - - LengthUnits in which value will be returned

Returns:

crane's height in specified units

getCraneHeight

public double getCraneHeight()

Returns crane height in pixels.

Returns:

crane height in pixels

getBoundingRectangle

public BoundingRectangle getBoundingRectangle()

Specified by:

getBoundingRectangle in interface LevelMarkup