agi.foundation.geometry.discrete

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

Class SpecifiedCentralBodyCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.CentralBodyCoverageGrid

agi.foundation.geometry.discrete.SpecifiedCentralBodyCoverageGrid

All Implemented Interfaces:

ICoverageGrid

public final class SpecifiedCentralBodyCoverageGrid
extends CentralBodyCoverageGrid

Wraps a previously generated set of grid points with their respective boundaries or accepts a specified list of Cartographic grid point locations. The grid is stored in memory instead of being generated on demand.

Constructor Summary

Constructors

Constructor and Description
SpecifiedCentralBodyCoverageGrid(CentralBodyCoverageGrid existingGrid) Construct a new instance based on a given instance of another CentralBodyCoverageGrid.
SpecifiedCentralBodyCoverageGrid(CentralBody centralBody, CoverageGridPoint... points) Construct a new instance based on a given set of GridPoints and their corresponding central body.
SpecifiedCentralBodyCoverageGrid(CentralBody centralBody, List<Cartographic> points, List<CartographicExtent> gridPointExtents, boolean useCellSurfaceAreaForWeight, boolean saveGridCell) Construct a new instance based on a given reference surface, a list of Cartographic points, and the corresponding extents of each grid cell.
SpecifiedCentralBodyCoverageGrid(CentralBody centralBody, List<CoverageGridPoint> points) Construct a new instance based on a given list of GridPoints and their corresponding central body.
SpecifiedCentralBodyCoverageGrid(CentralBody centralBody, TerrainProvider terrainProvider, CoverageGridPoint... points) Construct a new instance based on a given set of GridPoints and their corresponding terrain.
SpecifiedCentralBodyCoverageGrid(CentralBody centralBody, TerrainProvider terrainProvider, List<Cartographic> points, List<CartographicExtent> gridPointExtents, boolean useCellSurfaceAreaForWeight, boolean saveGridCell) Construct a new instance based on a given reference terrain, a list of Cartographic points, and the corresponding extents of each grid cell.
SpecifiedCentralBodyCoverageGrid(CentralBody centralBody, TerrainProvider terrainProvider, List<CoverageGridPoint> points) Construct a new instance based on a given list of GridPoints and their corresponding terrain.

Method Summary

Modifier and Type	Method and Description
List<CoverageGridPoint>	generateGridPoints() Return the specified list of grid points stored in memory.
TerrainProvider	getReferenceTerrain() Gets the reference terrain and recalculates the height of the grid points.
void	setReferenceTerrain(TerrainProvider value) Sets the reference terrain and recalculates the height of the grid points.

Methods inherited from class agi.foundation.geometry.discrete.CentralBodyCoverageGrid

getCentralBody, getGridCellBoundaries, getGridCellBoundary, getHeightRelativeToSurface, getReferenceFrame, setCentralBody

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecifiedCentralBodyCoverageGrid

public SpecifiedCentralBodyCoverageGrid(@Nonnull
                                        CentralBodyCoverageGrid existingGrid)

Construct a new instance based on a given instance of another CentralBodyCoverageGrid.

Using this as a wrapper for another grid will store the generated grid in memory so that it is only generated once.

Parameters:

existingGrid - An existing grid.

Throws:

ArgumentNullException - Thrown if existingGrid is null.

SpecifiedCentralBodyCoverageGrid

public SpecifiedCentralBodyCoverageGrid(@Nonnull
                                        CentralBody centralBody,
                                        @Nonnull
                                        List<Cartographic> points,
                                        @Nonnull
                                        List<CartographicExtent> gridPointExtents,
                                        boolean useCellSurfaceAreaForWeight,
                                        boolean saveGridCell)

Construct a new instance based on a given reference surface, a list of Cartographic points, and the corresponding extents of each grid cell.

When specifying Cartographic values, a rectangular grid point cell is assumed. If a non-rectangular grid cell is desired, extend CentralBodyCoverageGrid to implement the gridding algorithm along with the method to define the grid cell boundaries.

Parameters:

centralBody - The central body on which this grid is defined.

points - The planetodetic locations of the grid points.

gridPointExtents - The extents of the grid point cells.

useCellSurfaceAreaForWeight - Specifies if the surface area of the relevant extent is used for the grid weight, otherwise the value of 1 is used.

saveGridCell - Specifies if the grid cell is to be saved.

Throws:

ArgumentException - Thrown if the length of points does not match the length of gridPointExtents.

ArgumentNullException - Thrown if centralBody, points, or gridPointExtents is null.

SpecifiedCentralBodyCoverageGrid

public SpecifiedCentralBodyCoverageGrid(@Nonnull
                                        CentralBody centralBody,
                                        @Nonnull
                                        TerrainProvider terrainProvider,
                                        @Nonnull
                                        List<Cartographic> points,
                                        @Nonnull
                                        List<CartographicExtent> gridPointExtents,
                                        boolean useCellSurfaceAreaForWeight,
                                        boolean saveGridCell)

Construct a new instance based on a given reference terrain, a list of Cartographic points, and the corresponding extents of each grid cell.

When specifying Cartographic values, a rectangular grid point cell is assumed. If a non-rectangular grid cell is desired, extend CentralBodyCoverageGrid to implement the gridding algorithm along with the method to define the grid cell boundaries.

Parameters:

centralBody - The central body on which this grid is defined.

terrainProvider - The TerrainProvider used to generate the height of the grid points.

points - The planetodetic locations of the grid points.

gridPointExtents - The extents of the grid point cells.

useCellSurfaceAreaForWeight - Specifies if the surface area of the relevant extent is used for the grid weight, otherwise the value of 1 is used.

saveGridCell - Specifies if the grid cell is to be saved.

Throws:

ArgumentException - Thrown if the length of points does not match the length of gridPointExtents.

ArgumentNullException - Thrown if terrainProvider, centralBody, points, or gridPointExtents is null.

SpecifiedCentralBodyCoverageGrid

public SpecifiedCentralBodyCoverageGrid(@Nonnull
                                        CentralBody centralBody,
                                        @Nonnull
                                        CoverageGridPoint... points)

Construct a new instance based on a given set of GridPoints and their corresponding central body.

Parameters:

centralBody - The central body on which these grid points are defined.

points - The set of grid points.

Throws:

ArgumentNullException - Thrown if centralBody or points is null.

SpecifiedCentralBodyCoverageGrid

public SpecifiedCentralBodyCoverageGrid(@Nonnull
                                        CentralBody centralBody,
                                        @Nonnull
                                        List<CoverageGridPoint> points)

Construct a new instance based on a given list of GridPoints and their corresponding central body.

Parameters:

centralBody - The central body on which these grid points are defined.

points - The set of grid points.

Throws:

ArgumentNullException - Thrown if centralBody or points is null.

ArgumentException - Thrown if no grid points are supplied.

SpecifiedCentralBodyCoverageGrid

public SpecifiedCentralBodyCoverageGrid(@Nonnull
                                        CentralBody centralBody,
                                        @Nonnull
                                        TerrainProvider terrainProvider,
                                        @Nonnull
                                        CoverageGridPoint... points)

Construct a new instance based on a given set of GridPoints and their corresponding terrain.

Parameters:

centralBody - The central body on which these grid points are defined.

terrainProvider - The TerrainProvider used to generate the height of the grid points.

points - The set of grid points.

Throws:

ArgumentNullException - Thrown if terrainProvider, centralBody, or points is null.

SpecifiedCentralBodyCoverageGrid

public SpecifiedCentralBodyCoverageGrid(@Nonnull
                                        CentralBody centralBody,
                                        @Nonnull
                                        TerrainProvider terrainProvider,
                                        @Nonnull
                                        List<CoverageGridPoint> points)

Construct a new instance based on a given list of GridPoints and their corresponding terrain.

Parameters:

centralBody - The central body on which these grid points are defined.

terrainProvider - The TerrainProvider used to generate the height of the grid points.

points - The set of grid points.

Throws:

ArgumentNullException - Thrown when terrainProvider, centralBody, or points is null.

Method Detail

getReferenceTerrain

public TerrainProvider getReferenceTerrain()

Gets the reference terrain and recalculates the height of the grid points.

Overrides:

getReferenceTerrain in class CentralBodyCoverageGrid

setReferenceTerrain

public void setReferenceTerrain(TerrainProvider value)

Sets the reference terrain and recalculates the height of the grid points.

Overrides:

setReferenceTerrain in class CentralBodyCoverageGrid

generateGridPoints

public List<CoverageGridPoint> generateGridPoints()

Return the specified list of grid points stored in memory.

Specified by:

generateGridPoints in interface ICoverageGrid

Specified by:

generateGridPoints in class CentralBodyCoverageGrid

Returns:

The specified list of grid points.