agi.foundation.geometry.discrete

(agi.foundation.spatial-2024r2.jar)

Class VolumeElementCoverageGridCell<T>

java.lang.Object

agi.foundation.geometry.discrete.VolumeElementCoverageGridCell<T>

Type Parameters:

T - The type used to describe the bounds of the grid cell.

All Implemented Interfaces:

ICoverageGridCell

public class VolumeElementCoverageGridCell<T>
extends Object
implements ICoverageGridCell

A three dimensional grid cell that contains the volume and coordinate bounds.

Constructor Summary

Constructors

Constructor and Description
VolumeElementCoverageGridCell(double volume, T gridCellBounds) Initializes a volume element grid cell.

Method Summary

Modifier and Type	Method and Description
T	getGridCellBounds() Gets the grid cell bounds.
Double	scalarMeasure(JulianDate date, int dimension) Returns a scalar measure for the grid cell.

Methods inherited from class java.lang.Object

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

Constructor Detail

VolumeElementCoverageGridCell

public VolumeElementCoverageGridCell(double volume,
                                     @Nullable
                                     T gridCellBounds)

Initializes a volume element grid cell.

Parameters:

volume - The volume of this grid cell.

gridCellBounds - The bounds in each coordinate for this grid. This can be null.

Method Detail

scalarMeasure

@Nullable
public final Double scalarMeasure(@Nonnull
                                             JulianDate date,
                                             int dimension)

Returns a scalar measure for the grid cell. The dimension parameter indicates the spatial dimension.

This grid cell type returns the volume (dimension 3). It will return null otherwise.

Some examples of scalar measure are: for dimension 1 the perimeter, for dimension 2 the area or surface area, for dimension 3 the volume.

Specified by:

scalarMeasure in interface ICoverageGridCell

Parameters:

date - The date at which to evaluate the scalar measure of the grid cell.

dimension - The dimension of the scalar measure requested.

Returns:

The scalar measure, if available; otherwise null.

getGridCellBounds

@Nullable
public final T getGridCellBounds()

Gets the grid cell bounds.