HorizontalGrid (Environmental Data Abstraction Library 1.5.2 API)

All Superinterfaces:

DiscreteDomain<HorizontalPosition,GridCell2D>, DiscreteHorizontalDomain<GridCell2D>, Domain<HorizontalPosition>, HorizontalDomain, Serializable

All Known Subinterfaces:

RectilinearGrid, RegularGrid, StaggeredHorizontalGrid

All Known Implementing Classes:

AbstractCurvilinearGrid, AbstractHorizontalGrid, AbstractTransformedGrid, CdmTransformedGrid, DefinedStaggeredGrid, DerivedStaggeredGrid, LookUpTableGrid, MapDomain, RectilinearGridImpl, RegularGridImpl
```
public interface HorizontalGrid
extends DiscreteHorizontalDomain<GridCell2D>, Serializable
```
A two-dimensional grid in the horizontal plane that is referenced to a 2D horizontal coordinate reference system. If each individual grid axis is aligned with the axes of the CRS, the RectilinearGrid class can be used.

Author:

Jon Blower

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`GridCoordinates2D`	`findIndexOf(HorizontalPosition position)`	Finds the index of the specified position within this domain
`Array2D<GridCell2D>`	`getDomainObjects()`	Returns an `Array` of domain objects that comprise this domain.
`int`	`getXSize()`
`int`	`getYSize()`
`int`	`hashCode()`
`long`	`size()`	Returns the size of this domain.

Methods inherited from interface uk.ac.rdg.resc.edal.domain.Domain
contains

Methods inherited from interface uk.ac.rdg.resc.edal.domain.HorizontalDomain
getBoundingBox, getCoordinateReferenceSystem, getGeographicBoundingBox

- Method Detail
  - getDomainObjects
```
Array2D<GridCell2D> getDomainObjects()
```
    Description copied from interface: DiscreteDomain
    
    Returns an Array of domain objects that comprise this domain.
    
    Specified by:
    
    getDomainObjects in interface DiscreteDomain<HorizontalPosition,GridCell2D>
  - size
```
long size()
```
    Returns the size of this domain. Equivalent to getXSize() * getYSize()
    
    Specified by:
    
    size in interface DiscreteHorizontalDomain<GridCell2D>
  - getXSize
```
int getXSize()
```
    Returns:
    
    The size of the x-axis
  - getYSize
```
int getYSize()
```
    Returns:
    
    The size of the y-axis
  - findIndexOf
```
GridCoordinates2D findIndexOf(HorizontalPosition position)
```
    Finds the index of the specified position within this domain
    
    Parameters:
    
    position - The position to find the index of
    
    Returns:
    
    A GridCoordinates2D object representing the index of the position within the domain, or null if the position is outside the domain.
  - equals
```
boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
int hashCode()
```
    Overrides:
    
    hashCode in class Object