java.lang.Object
- java.lang.Enum<CellDirection>
- - com.anylogic.engine.CellDirection

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<CellDirection>

public enum CellDirection
extends java.lang.Enum<CellDirection>

Constants for directions in discrete space

Author:: AnyLogic North America, LLC https://anylogic.com

Enum Constant Summary

Enum Constants
Enum Constant	Description
`EAST`
`NORTH`
`NORTHEAST`
`NORTHWEST`
`SOUTH`
`SOUTHEAST`
`SOUTHWEST`
`WEST`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getAngle()`	Returns the angle value corresponding to this direction
`static CellDirection`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static CellDirection[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORTH

public static final CellDirection NORTH

EAST

public static final CellDirection EAST

SOUTH

public static final CellDirection SOUTH

WEST

public static final CellDirection WEST

NORTHEAST

public static final CellDirection NORTHEAST

SOUTHEAST

public static final CellDirection SOUTHEAST

SOUTHWEST

public static final CellDirection SOUTHWEST

NORTHWEST

public static final CellDirection NORTHWEST

Method Detail

values

public static CellDirection[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CellDirection c : CellDirection.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static CellDirection valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name; java.lang.NullPointerException - if the argument is null

getAngle

public double getAngle()

Returns the angle value corresponding to this direction

Returns:: the angle value (from 0 to 2*PI)

How can we improve this article?

Enum CellDirection