org.gridfour.coordinates

Class GridPoint

java.lang.Object

org.gridfour.coordinates.GridPoint

All Implemented Interfaces:

IGridPoint

public class GridPoint
extends Object
implements IGridPoint

Provides elements and methods specifying a point in the grid coordinate system.

Constructor Summary

Constructors

Constructor and Description
GridPoint(double row, double column) Standard constructor.
GridPoint(double row, double column, int iRow, int iColumn) Standard constructor.

Method Summary

Modifier and Type	Method and Description
double	getColumn() Get the column value associated with the grid point
int	getColumnInt() Gets the column index associated with the grid point
double	getRow() Get the row value associated with the grid point
int	getRowInt() Gets the row index associated with the grid point
double	getX() Returns the floating point value associated with the columnar position of the grid point.
double	getY() Returns the floating point value associated with the row position of the grid point.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GridPoint

public GridPoint(double row,
                 double column)

Standard constructor.

The grid coordinates are a real-valued and potentially fractional row and column value.

Parameters:

row - a finite, real-valued coordinate in the grid system

column - a finite, real-valued coordinate in the grid system

GridPoint

public GridPoint(double row,
                 double column,
                 int iRow,
                 int iColumn)

Standard constructor.

The grid coordinates are a real-valued and potentially fractional row and column value.

Parameters:

row - a finite, real-valued coordinate in the grid system

column - a finite, real-valued coordinate in the grid system

iRow - an integer value, usually derived from the row value

iColumn - an integer value, usual derived from the column value

Method Detail

getRow

public double getRow()

Get the row value associated with the grid point

Specified by:

getRow in interface IGridPoint

Returns:

a potentially non-integral row value

getColumn

public double getColumn()

Get the column value associated with the grid point

Specified by:

getColumn in interface IGridPoint

Returns:

a potentially non-integral column value

getRowInt

public int getRowInt()

Gets the row index associated with the grid point

Specified by:

getRowInt in interface IGridPoint

Returns:

an integer index

getColumnInt

public int getColumnInt()

Gets the column index associated with the grid point

Specified by:

getColumnInt in interface IGridPoint

Returns:

an integer index

getX

public double getX()

Returns the floating point value associated with the columnar position of the grid point. This value is provided as a convenience for developers who find it useful to specify coordinates in terms of (x, y) rather than row and column.

Returns:

a potentially non-integral floating-point value.

getY

public double getY()

Returns the floating point value associated with the row position of the grid point. This value is provided as a convenience for developers who find it useful to specify coordinates in terms of (x, y) rather than row and column.

Returns:

a potentially non-integral floating-point value.

toString

public String toString()

Overrides:

toString in class Object