Package group3dlocaliser.grids

Class SphericalGrid

java.lang.Object

group3dlocaliser.grids.Grid3D

group3dlocaliser.grids.SphericalGrid

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class SphericalGrid
extends Grid3D

Simple spherical grid. Points are spaced at even angles vertically. The number of points generated at each vertical angles is reduced as vertical angle increases in order to keep spacing more or less even.

Author:

dg50

Field Summary

Fields

Modifier and Type	Field	Description
static final String	gridName

Constructor Summary

Constructors

Constructor	Description
SphericalGrid(String settingsName)

Method Summary

Modifier and Type	Method	Description
String	getGridName()
PamVector	getNextPoint()	Get the next point in the grid.
Serializable	getSettingsReference()
long	getSettingsVersion()
int	getTotalPoints()	Get the total number of points in the grid.
void	resetGrid()	Reset the grid so that the next call to getNextPoint will return the first grid point again.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class group3dlocaliser.grids.Grid3D

getUnitName, getUnitType

Methods inherited from class java.lang.Object

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

Field Details

gridName

public static final String gridName

See Also:

• Constant Field Values

Constructor Details

SphericalGrid

public SphericalGrid(String settingsName)

Method Details

getSettingsReference

public Serializable getSettingsReference()

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

getGridName

public String getGridName()

Specified by:

getGridName in class Grid3D

Returns:

A descriptive name for the grid.

getTotalPoints

public int getTotalPoints()

Description copied from class: Grid3D

Get the total number of points in the grid.

Specified by:

getTotalPoints in class Grid3D

Returns:

number of grid points

resetGrid

public void resetGrid()

Description copied from class: Grid3D

Reset the grid so that the next call to getNextPoint will return the first grid point again.

Specified by:

resetGrid in class Grid3D

getNextPoint

public PamVector getNextPoint()

Description copied from class: Grid3D

Get the next point in the grid. Will return null when it's complete.

Specified by:

getNextPoint in class Grid3D

Returns:

next grid point