Package analoginput.brainboxes

Class BrainBoxDevices

java.lang.Object

analoginput.brainboxes.BrainBoxDevices

All Implemented Interfaces:

AnalogDeviceType, PamSettings, SettingsNameProvider

public class BrainBoxDevices
extends Object
implements AnalogDeviceType, PamSettings

Constructor Summary

Constructors

Constructor	Description
BrainBoxDevices(AnalogDevicesManager analogDevicesManager, SettingsNameProvider settingsNameProvider, AnalogSensorUser sensorUser)

Method Summary

Modifier and Type	Method	Description
List<AnalogRangeData>	getAvailableRanges(int iChan)
BrainBoxParams	getBrainBoxParams()
PamDialogPanel	getDevicePanel()
AnalogDeviceParams	getDeviceParams()
String	getDeviceType()
int	getNumChannels()
Serializable	getSettingsReference()
long	getSettingsVersion()
String	getUnitName()
String	getUnitType()
void	prepareDevice()
AnalogSensorData	readData(int item)
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setBrainBoxParams(BrainBoxParams brainBoxParams)
boolean	setChannelRange(AnalogRangeData analogRange)
void	setDeviceParams(AnalogDeviceParams deviceParams)

Methods inherited from class java.lang.Object

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

Constructor Details

BrainBoxDevices

public BrainBoxDevices(AnalogDevicesManager analogDevicesManager,
 SettingsNameProvider settingsNameProvider,
 AnalogSensorUser sensorUser)

Method Details

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

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Parameters:

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

getDeviceType

public String getDeviceType()

Specified by:

getDeviceType in interface AnalogDeviceType

getNumChannels

public int getNumChannels()

Specified by:

getNumChannels in interface AnalogDeviceType

getAvailableRanges

public List<AnalogRangeData> getAvailableRanges(int iChan)

Specified by:

getAvailableRanges in interface AnalogDeviceType

setChannelRange

public boolean setChannelRange(AnalogRangeData analogRange)

Specified by:

setChannelRange in interface AnalogDeviceType

readData

public AnalogSensorData readData(int item)
                          throws AnalogReadException

Specified by:

readData in interface AnalogDeviceType

Throws:

AnalogReadException

getDevicePanel

public PamDialogPanel getDevicePanel()

Specified by:

getDevicePanel in interface AnalogDeviceType

getBrainBoxParams

public BrainBoxParams getBrainBoxParams()

Returns:

the brainBoxParams

setBrainBoxParams

public void setBrainBoxParams(BrainBoxParams brainBoxParams)

Parameters:

brainBoxParams - the brainBoxParams to set

getDeviceParams

public AnalogDeviceParams getDeviceParams()

Specified by:

getDeviceParams in interface AnalogDeviceType

setDeviceParams

public void setDeviceParams(AnalogDeviceParams deviceParams)

Specified by:

setDeviceParams in interface AnalogDeviceType

prepareDevice

public void prepareDevice()

Specified by:

prepareDevice in interface AnalogDeviceType