Package uk.ac.rdg.resc.edal.grid

Class GridCell2DImpl

java.lang.Object

uk.ac.rdg.resc.edal.grid.GridCell2DImpl

All Implemented Interfaces:

Domain<HorizontalPosition>, GridCell2D, HorizontalCell

public final class GridCell2DImpl
extends Object
implements GridCell2D

Simple immutable implementation of a GridCell2D.

Author:

Jon, Guy

Constructor Summary

Constructors

Constructor	Description
GridCell2DImpl(GridCoordinates2D gridCoords, HorizontalPosition centre, Polygon footprint, HorizontalGrid parentGrid)

Method Summary

Modifier and Type	Method	Description
boolean	contains(HorizontalPosition position)
HorizontalPosition	getCentre()
Polygon	getFootprint()
GridCoordinates2D	getGridCoordinates()
HorizontalGrid	getParentDomain()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GridCell2DImpl

public GridCell2DImpl(GridCoordinates2D gridCoords,
                      HorizontalPosition centre,
                      Polygon footprint,
                      HorizontalGrid parentGrid)

Parameters:

gridCoords - The indices of this cell within its parent grid

centre - The centre HorizontalPosition of this grid cell

footprint - A Polygon representing the bounding box of this grid cell. Does not necessarily have to be a tight-bound around the cell

parentGrid - The HorizontalGrid which this GridCell2D is part of

Method Detail

getGridCoordinates

public GridCoordinates2D getGridCoordinates()

Specified by:

getGridCoordinates in interface GridCell2D

Returns:

the coordinates within the parent HorizontalGrid

getCentre

public HorizontalPosition getCentre()

Specified by:

getCentre in interface HorizontalCell

Returns:

the centre of the cell in horizontal space

getFootprint

public Polygon getFootprint()

Specified by:

getFootprint in interface HorizontalCell

Returns:

the footprint of this cell in horizontal space.

contains

public boolean contains(HorizontalPosition position)

Specified by:

contains in interface Domain<HorizontalPosition>

Returns:

true if the given position is contained within this domain.

getParentDomain

public HorizontalGrid getParentDomain()

Specified by:

getParentDomain in interface GridCell2D

Specified by:

getParentDomain in interface HorizontalCell

Returns:

the grid of which this cell is a part

toString

public String toString()

Overrides:

toString in class Object