agi.foundation.geometry.discrete

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

Class CentralBodyCoverageGrid

java.lang.Object

agi.foundation.geometry.discrete.CentralBodyCoverageGrid

All Implemented Interfaces:

ICoverageGrid

Direct Known Subclasses:

ExtrudedCentralBodyCoverageGrid, GlobalCoverageGrid, IntersectionWithSurfaceRegionsCoverageGrid, LatitudeBoundsCoverageGrid, LatitudeLineCoverageGrid, LongitudeLineCoverageGrid, SpecifiedCentralBodyCoverageGrid, SurfaceRegionsCoverageGrid

public abstract class CentralBodyCoverageGrid
extends Object
implements ICoverageGrid

The abstract base class for a ICoverageGrid that produces grid points defined relative to a CentralBody (get / set).

The ReferenceFrame (get) for this type of grid is the fixed frame of the associated CentralBody (get / set).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CentralBodyCoverageGrid() Initializes a new instance.
protected	CentralBodyCoverageGrid(CentralBody centralBody) Initializes a new instance with a specified central body.
protected	CentralBodyCoverageGrid(CentralBodyCoverageGrid existingGrid) Initializes a new instance using the same reference surface as an existing grid.
protected	CentralBodyCoverageGrid(CentralBody centralBody, TerrainProvider terrainProvider) Initializes a new instance with a specified reference terrain.
protected	CentralBodyCoverageGrid(TerrainProvider terrainProvider) Initializes a new instance with a specified reference terrain.

Method Summary

Modifier and Type	Method and Description
abstract List<CoverageGridPoint>	generateGridPoints() Generate the set of grid points.
CentralBody	getCentralBody() Gets the central body associated with this grid.
ArrayList<EllipsoidSurfaceCurve>	getGridCellBoundaries(List<CoverageGridPoint> points) Generates a list of boundary curves corresponding to the grid point cells represented by each grid point in the specified list.
EllipsoidSurfaceCurve	getGridCellBoundary(CoverageGridPoint point) Generates a boundary curve for the given grid point cell represented by the given grid point.
double	getHeightRelativeToSurface(double longitude, double latitude) Gets the height of a point at a specific longitude and latitude.
ReferenceFrame	getReferenceFrame() Gets the reference frame for this grid, which is the CentralBody (get / set) fixed frame.
TerrainProvider	getReferenceTerrain() Gets the reference terrain with which the grid points are defined.
void	setCentralBody(CentralBody value) Sets the central body associated with this grid.
void	setReferenceTerrain(TerrainProvider value) Sets the reference terrain with which the grid points are defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

CentralBodyCoverageGrid

protected CentralBodyCoverageGrid()

Initializes a new instance.

CentralBodyCoverageGrid

protected CentralBodyCoverageGrid(@Nonnull
                                  CentralBody centralBody)

Initializes a new instance with a specified central body. The ReferenceFrame (get) defaults to the central body's fixed frame.

Parameters:

centralBody - The central body relative to which the grid points are defined.

Throws:

ArgumentNullException - Thrown when centralBody is null.

CentralBodyCoverageGrid

protected CentralBodyCoverageGrid(@Nonnull
                                  TerrainProvider terrainProvider)

Initializes a new instance with a specified reference terrain.

Parameters:

terrainProvider - The surface with which to define the grid points.

Throws:

ArgumentNullException - Thrown when terrainProvider is null.

CentralBodyCoverageGrid

protected CentralBodyCoverageGrid(@Nonnull
                                  CentralBody centralBody,
                                  @Nonnull
                                  TerrainProvider terrainProvider)

Initializes a new instance with a specified reference terrain. The ReferenceFrame (get) defaults to the central body's fixed frame.

Parameters:

centralBody - The central body that the terrain provider is specified relative to.

terrainProvider - The surface with which to define the grid points.

Throws:

ArgumentNullException - Thrown when terrainProvider or centralBody is null.

CentralBodyCoverageGrid

protected CentralBodyCoverageGrid(@Nonnull
                                  CentralBodyCoverageGrid existingGrid)

Initializes a new instance using the same reference surface as an existing grid.

Parameters:

existingGrid - An existing grid.

Method Detail

generateGridPoints

public abstract List<CoverageGridPoint> generateGridPoints()

Generate the set of grid points.

When implementing, note that the space represented by each grid point should not overlap.

Specified by:

generateGridPoints in interface ICoverageGrid

Returns:

The set of grid points.

getReferenceTerrain

public TerrainProvider getReferenceTerrain()

Gets the reference terrain with which the grid points are defined.

When GeometricPrimitiveCoverageGrid.generateGridPoints() or CentralBodyCoverageGrid.getHeightRelativeToSurface(double, double) is called, the shape of ReferenceTerrain (get / set) must match CentralBody (get / set).

setReferenceTerrain

public void setReferenceTerrain(TerrainProvider value)

Sets the reference terrain with which the grid points are defined.

When GeometricPrimitiveCoverageGrid.generateGridPoints() or CentralBodyCoverageGrid.getHeightRelativeToSurface(double, double) is called, the shape of ReferenceTerrain (get / set) must match CentralBody (get / set).

getCentralBody

public CentralBody getCentralBody()

Gets the central body associated with this grid.

When GeometricPrimitiveCoverageGrid.generateGridPoints() or CentralBodyCoverageGrid.getHeightRelativeToSurface(double, double) is called, the shape of ReferenceTerrain (get / set) must match CentralBody (get / set).

setCentralBody

public void setCentralBody(CentralBody value)

Sets the central body associated with this grid.

When GeometricPrimitiveCoverageGrid.generateGridPoints() or CentralBodyCoverageGrid.getHeightRelativeToSurface(double, double) is called, the shape of ReferenceTerrain (get / set) must match CentralBody (get / set).

getReferenceFrame

@Nullable
public final ReferenceFrame getReferenceFrame()

Gets the reference frame for this grid, which is the CentralBody (get / set) fixed frame. If the CentralBody (get / set) has not been set, then this will return null.

Specified by:

getReferenceFrame in interface ICoverageGrid

getHeightRelativeToSurface

public final double getHeightRelativeToSurface(double longitude,
                                               double latitude)

Gets the height of a point at a specific longitude and latitude.

If ReferenceTerrain (get / set) is null, returns zero. Otherwise, ReferenceTerrain (get / set) is used to find the height with respect to the CentralBody (get / set).

Parameters:

longitude - The longitude of the desired grid point.

latitude - The latitude of the desired grid point.

Returns:

The height of the specified grid point.

Throws:

ArgumentOutOfRangeException - Thrown when the latitude is outside the range -π/2 to π/2, or the longitude is outside the range -π to π.

IllegalStateException - Thrown when the Shape (get / set) of the ReferenceTerrain (get / set) does not match the Shape (get / set) of the CentralBody (get / set).

getGridCellBoundary

@Nullable
public EllipsoidSurfaceCurve getGridCellBoundary(@Nonnull
                                                            CoverageGridPoint point)

Generates a boundary curve for the given grid point cell represented by the given grid point.

This method provides a default implementation of the boundary by interpolating the grid cell vertices with EllipsoidRhumbLines. The method is meant to be overridden if a different type of boundary is intended. The boundary created currently works with the Shape (get / set), not the ReferenceTerrain (get / set).

Parameters:

point - The grid point containing the information about its boundary.

Returns:

If the point contains information about the grid cell vertices, this returns the boundary curve. Otherwise, this returns null.

getGridCellBoundaries

@Nonnull
public final ArrayList<EllipsoidSurfaceCurve> getGridCellBoundaries(@Nonnull
                                                                              List<CoverageGridPoint> points)

Generates a list of boundary curves corresponding to the grid point cells represented by each grid point in the specified list.

Parameters:

points - The grid points containing the information about the grid point cells.

Returns:

If each point contains information about the grid cell vertices, this returns the corresponding boundary curve in the list. Otherwise, that entry will be null.