marf.math
Class Matrix.Direction

java.lang.Object
  |
  +--marf.math.Matrix.Direction
Enclosing class:
Matrix

public static class Matrix.Direction
extends java.lang.Object

Indicates the direction in which a matrix to be extended. Might emerge to generic integer Enum in marf.util eventually.


Field Summary
static int EAST
          Indicates East direction.
static int NORTH
          Indicates North direction.
static int SOUTH
          Indicates South direction.
static int WEST
          Indicates West direction.
 
Constructor Summary
Matrix.Direction()
          Default constructor.
Matrix.Direction(int piDirection)
          Direction Constructor.
Matrix.Direction(Matrix.Direction poDirection)
          Copy Constructor.
 
Method Summary
 int getDirection()
          Retrieves curret direction.
 void setDirection(int piDirection)
          Sets new value of current direction.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EAST

public static final int EAST
Indicates East direction.

See Also:
Constant Field Values

WEST

public static final int WEST
Indicates West direction.

See Also:
Constant Field Values

NORTH

public static final int NORTH
Indicates North direction.

See Also:
Constant Field Values

SOUTH

public static final int SOUTH
Indicates South direction.

See Also:
Constant Field Values
Constructor Detail

Matrix.Direction

public Matrix.Direction()
Default constructor.


Matrix.Direction

public Matrix.Direction(int piDirection)
Direction Constructor. Calls setDirection() internally.

Parameters:
piDirection - custom direction to extend
Throws:
java.lang.RuntimeException - if piDirection is out of range
See Also:
setDirection(int)

Matrix.Direction

public Matrix.Direction(Matrix.Direction poDirection)
Copy Constructor.

Parameters:
poDirection - custom direction object to extend
Method Detail

getDirection

public int getDirection()
Retrieves curret direction.

Returns:
current value of direction

setDirection

public void setDirection(int piDirection)
Sets new value of current direction.

Parameters:
piDirection - current value of direction to be
Throws:
java.lang.RuntimeException - if piDirection is outside of valid range of values.