Package angleMeasurement

Class AngleMeasurement

java.lang.Object

angleMeasurement.AngleMeasurement

All Implemented Interfaces:

PamSettings, SettingsNameProvider

Direct Known Subclasses:

FluxgateWorldAngles

public abstract class AngleMeasurement
extends Object
implements PamSettings

Constructor Summary

Constructors

Constructor	Description
AngleMeasurement(String name)

Method Summary

Modifier and Type	Method	Description
void	addMeasurementListener(AngleMeasurementListener angleMeasurementListener)
double	getAngleOffset()
AngleParameters	getAngleParameters()
Double	getCalibratedAngle()
double	getCalibratedAngle(double rawAngle)	Converts a raw angle into a calibrated angle.
abstract Double	getCorrectedAngle()
String	getName()
abstract Double	getRawAngle()
String	getUnitName()
String	getUnitType()
void	removeMeasurementListener(AngleMeasurementListener angleMeasurementListener)
void	setAngleOffset(double angleOffset)
void	setAngleParameters(AngleParameters angleParameters)
void	setCalibrationData(double[] calibrationData)
void	setName(String name)
abstract boolean	settings(Frame parentFrame)
void	setupCalibration()	Sets up the angle calibration.
abstract void	setZero()

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getSettingsReference, getSettingsVersion, restoreSettings

Constructor Details

AngleMeasurement

public AngleMeasurement(String name)

Method Details

getRawAngle

public abstract Double getRawAngle()

getCalibratedAngle

public Double getCalibratedAngle()

getCorrectedAngle

public abstract Double getCorrectedAngle()

setZero

public abstract void setZero()

settings

public abstract boolean settings(Frame parentFrame)

getAngleOffset

public double getAngleOffset()

setAngleOffset

public void setAngleOffset(double angleOffset)

getName

public String getName()

setName

public void setName(String name)

getUnitName

public String getUnitName()

Specified by:

getUnitName in interface SettingsNameProvider

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Click detector

getAngleParameters

public AngleParameters getAngleParameters()

setAngleParameters

public void setAngleParameters(AngleParameters angleParameters)

addMeasurementListener

public void addMeasurementListener(AngleMeasurementListener angleMeasurementListener)

removeMeasurementListener

public void removeMeasurementListener(AngleMeasurementListener angleMeasurementListener)

setCalibrationData

public void setCalibrationData(double[] calibrationData)

setupCalibration

public void setupCalibration()

Sets up the angle calibration. Most angle measurement devices wil just use it as is, but some may be able to extract the data from it and upload them to the external device.

getCalibratedAngle

public double getCalibratedAngle(double rawAngle)

Converts a raw angle into a calibrated angle.
Most angle measurement devices wil just use it as is, but some may be able to extract the data from it and upload them to the external device, in which case developer will probably want to override this function so that it doesn't do anything (just returns the rawAngle)

Parameters:

rawAngle - uncalibrated angle

Returns:

calibrated angle