Package Map

Class MapParameters

java.lang.Object

Map.MapParameters

All Implemented Interfaces:

Serializable, Cloneable, ManagedParameters

public class MapParameters
extends Object
implements Serializable, Cloneable, ManagedParameters

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
boolean	allow3D	Allow 3D rotation using the shift key and mouse movement.
boolean	colourByEffort
boolean	colourHydrophonesByChannel
String	effortDataSource	Name of data block providing effort data.
boolean	hideGrid
boolean	hideSurface	hide the sea surface
int	mapRangeMetres	Value to store persistently between runs.
static final int	RANGE_RINGS_KM
static final int	RANGE_RINGS_M
static final int	RANGE_RINGS_NMI
static final int	RANGE_RINGS_NONE
double	rangeRingDistance
int	showRangeRings
int	symbolSize

Constructor Summary

Constructors

Constructor	Description
MapParameters()

Method Summary

Modifier and Type	Method	Description
int	getDataKeepTime()
int	getDataShowTime()
boolean[]	getMapContours()
File	getMapFile()
int	getMapRangeMetres()
PamParameterSet	getParameterSet()	Get a set of data that describes all of the parameters in a class
double	getRangeRingDistance()
int	getShowRangeRings()
int	getSymbolSize()
int	getTrackShowTime()
boolean	isAllow3D()
boolean	isColourHydrophonesByChannel()
boolean	isHeadingUp()
boolean	isHideGrid()
boolean	isKeepShipCentred()
boolean	isKeepShipOnMap()
boolean	isShowGpsData()
boolean	isShowHydrophones()
boolean	isShowKey()
boolean	isShowPanZoom()
boolean	isViewerShowAll()
void	setAllow3D(boolean allow3d)
void	setColourHydrophonesByChannel(boolean colourHydrophonesByChannel)
void	setDataKeepTime(int dataKeepTime)
void	setDataShowTime(int dataShowTime)
void	setHeadingUp(boolean headingUp)
void	setHideGrid(boolean hideGrid)
void	setKeepShipCentred(boolean keepShipCentred)
void	setKeepShipOnMap(boolean keepShipOnMap)
void	setMapContours(boolean[] mapContours)
void	setMapFile(File mapFile)
void	setMapRangeMetres(int mapRangeMetres)
void	setRangeRingDistance(double rangeRingDistance)
void	setShowGpsData(boolean showGpsData)
void	setShowHydrophones(boolean showHydrophones)
void	setShowKey(boolean showKey)
void	setShowPanZoom(boolean showPanZoom)
void	setShowRangeRings(int showRangeRings)
void	setSymbolSize(int symbolSize)
void	setTrackShowTime(int trackShowTime)
void	setViewerShowAll(boolean viewerShowAll)

Methods inherited from class java.lang.Object

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

Field Details

colourHydrophonesByChannel

public boolean colourHydrophonesByChannel

symbolSize

public int symbolSize

colourByEffort

public boolean colourByEffort

effortDataSource

public String effortDataSource

Name of data block providing effort data.

mapRangeMetres

public int mapRangeMetres

Value to store persistently between runs.

RANGE_RINGS_NONE

public static final int RANGE_RINGS_NONE

See Also:

• Constant Field Values

RANGE_RINGS_M

public static final int RANGE_RINGS_M

See Also:

• Constant Field Values

RANGE_RINGS_KM

public static final int RANGE_RINGS_KM

See Also:

• Constant Field Values

RANGE_RINGS_NMI

public static final int RANGE_RINGS_NMI

See Also:

• Constant Field Values

showRangeRings

public int showRangeRings

rangeRingDistance

public double rangeRingDistance

hideGrid

public boolean hideGrid

allow3D

public boolean allow3D

Allow 3D rotation using the shift key and mouse movement.

hideSurface

public boolean hideSurface

hide the sea surface

Constructor Details

MapParameters

public MapParameters()

Method Details

getTrackShowTime

public int getTrackShowTime()

setTrackShowTime

public void setTrackShowTime(int trackShowTime)

getDataKeepTime

public int getDataKeepTime()

setDataKeepTime

public void setDataKeepTime(int dataKeepTime)

getDataShowTime

public int getDataShowTime()

setDataShowTime

public void setDataShowTime(int dataShowTime)

isViewerShowAll

public boolean isViewerShowAll()

setViewerShowAll

public void setViewerShowAll(boolean viewerShowAll)

isShowHydrophones

public boolean isShowHydrophones()

setShowHydrophones

public void setShowHydrophones(boolean showHydrophones)

isKeepShipOnMap

public boolean isKeepShipOnMap()

setKeepShipOnMap

public void setKeepShipOnMap(boolean keepShipOnMap)

isKeepShipCentred

public boolean isKeepShipCentred()

setKeepShipCentred

public void setKeepShipCentred(boolean keepShipCentred)

isHeadingUp

public boolean isHeadingUp()

setHeadingUp

public void setHeadingUp(boolean headingUp)

getMapFile

public File getMapFile()

setMapFile

public void setMapFile(File mapFile)

getMapContours

public boolean[] getMapContours()

setMapContours

public void setMapContours(boolean[] mapContours)

isShowKey

public boolean isShowKey()

setShowKey

public void setShowKey(boolean showKey)

isShowPanZoom

public boolean isShowPanZoom()

setShowPanZoom

public void setShowPanZoom(boolean showPanZoom)

isShowGpsData

public boolean isShowGpsData()

setShowGpsData

public void setShowGpsData(boolean showGpsData)

isColourHydrophonesByChannel

public boolean isColourHydrophonesByChannel()

setColourHydrophonesByChannel

public void setColourHydrophonesByChannel(boolean colourHydrophonesByChannel)

getSymbolSize

public int getSymbolSize()

setSymbolSize

public void setSymbolSize(int symbolSize)

getMapRangeMetres

public int getMapRangeMetres()

setMapRangeMetres

public void setMapRangeMetres(int mapRangeMetres)

getShowRangeRings

public int getShowRangeRings()

setShowRangeRings

public void setShowRangeRings(int showRangeRings)

getRangeRingDistance

public double getRangeRingDistance()

setRangeRingDistance

public void setRangeRingDistance(double rangeRingDistance)

isHideGrid

public boolean isHideGrid()

setHideGrid

public void setHideGrid(boolean hideGrid)

isAllow3D

public boolean isAllow3D()

setAllow3D

public void setAllow3D(boolean allow3d)

getParameterSet

public PamParameterSet getParameterSet()

Description copied from interface: ManagedParameters

Get a set of data that describes all of the parameters in a class

Specified by:

getParameterSet in interface ManagedParameters

Returns:

description of the parameters in a class.