AnyLogic
Expand
Font size
All Implemented Interfaces:
Serializable, Comparable<SimpleDirection>, Constable

@AnyLogicInternalAPI
public enum SimpleDirection
extends Enum<SimpleDirection>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Method Summary

Modifier and TypeMethodDescription
abstract PositiongetEndPosition(IPath path, Position out) 
abstract INodegetNextNode(INode node)
Call this method for NodeType.TRANSIT nodes only
abstract INodegetNextNode(IPath path) 
abstract IPathgetNextPath(INode node)
Call this method for NodeType.TRANSIT nodes only
abstract doublegetOffsetOnPath(double baseOffset, double relativeOffset) 
abstract doublegetOffsetOnPath(IPath path, double distance) 
abstract PositiongetPositionAtOffset(IPath path, double offset, Position out) 
abstract doublegetRemainingLength(IPath path, double baseOffset) 
abstract SimpleDirectionreverse() 
static SimpleDirectionvalueOf(String name)
Returns the enum constant of this class with the specified name.
static SimpleDirection[]values()
Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

values

public static SimpleDirection[] values()
Returns an array containing the constants of this enum class, in the order they are declared.
Returns:
an array containing the constants of this enum class, in the order they are declared

valueOf

public static SimpleDirection valueOf(String name)
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum class has no constant with the specified name
NullPointerException - if the argument is null

getNextNode

public abstract INode getNextNode(INode node)
Call this method for NodeType.TRANSIT nodes only
Parameters:
node - the node
Returns:
the next node in this direction

getNextPath

public abstract IPath getNextPath(INode node)
Call this method for NodeType.TRANSIT nodes only
Parameters:
node - the node
Returns:
the connected path in this direction

getNextNode

public abstract INode getNextNode(IPath path)

getOffsetOnPath

public abstract double getOffsetOnPath(double baseOffset,
 double relativeOffset)

getRemainingLength

public abstract double getRemainingLength(IPath path,
 double baseOffset)

reverse

public abstract SimpleDirection reverse()

getEndPosition

public abstract Position getEndPosition(IPath path,
 Position out)

getOffsetOnPath

public abstract double getOffsetOnPath(IPath path,
 double distance)

getPositionAtOffset

public abstract Position getPositionAtOffset(IPath path,
 double offset,
 Position out)