depthReadout
Interface DepthSystem

All Known Implementing Classes:

MccDepthSystem

public interface DepthSystem

Hydrophone depth may be read out in a number of different ways and may arrive from a number of different sources. The main DepthProcess will manage common functinaility and common data, but the actual work will be done through this interface.

Author:

Douglas Gillespie

Field Summary

static double	DEPTH_NO_DATA
static double	DEPTH_OUT_OF_RANGE

Method Summary

boolean	canConfigure() Say whether ot not a particular sensor can be configured.
boolean	configureSensor(java.awt.Frame parentFrame) Configure one of the sensors.
double	getDepth(int iSensor) Get the depth (should be in meters)
double	getDepthRawData(int iSensor) Get the depth (should be in meters)
boolean	readSensor(int iSensor) Read all data from a sensor.
boolean	shouldPoll() DepthProcess should ask this system for data every so often if this return false, then the data are comign from somewhere beyond the immediate contron of Pamgaurd and we just wait for it to arrive.

Field Detail

DEPTH_OUT_OF_RANGE

static final double DEPTH_OUT_OF_RANGE

See Also:

Constant Field Values

DEPTH_NO_DATA

static final double DEPTH_NO_DATA

See Also:

Constant Field Values

Method Detail

shouldPoll

boolean shouldPoll()

DepthProcess should ask this system for data every so often if this return false, then the data are comign from somewhere beyond the immediate contron of Pamgaurd and we just wait for it to arrive.

Returns:

true if the sensor needs to be polled.

getDepth

double getDepth(int iSensor)

Get the depth (should be in meters)

Parameters:

iSensor -

Returns:

depth in meters. or DEPTH_OUT_OF_RANGE or DEPTH_NO_DATA

readSensor

boolean readSensor(int iSensor)

Read all data from a sensor. These data should be stored locally in the concrete class and will then be retreived with other get... functions.

Parameters:

iSensor - number of the sensor

Returns:

true if the read went OK.

getDepthRawData

double getDepthRawData(int iSensor)

Get the depth (should be in meters)

Parameters:

iSensor -

Returns:

depth in meters. or DEPTH_OUT_OF_RANGE or DEPTH_NO_DATA

canConfigure

boolean canConfigure()

Say whether ot not a particular sensor can be configured.

Returns:

true if the sensor can be configured

configureSensor

boolean configureSensor(java.awt.Frame parentFrame)

Configure one of the sensors.

Parameters:

parentFrame - owner frame for dialog

Returns:

true if configurations went Ok.