networkTransfer.receive

Class NetworkReceiver

java.lang.Object

PamController.PamControlledUnit

networkTransfer.receive.NetworkReceiver

All Implemented Interfaces:

PamSettings

public class NetworkReceiver
extends PamControlledUnit
implements PamSettings

Receive near real time data over the network in the form of packaged PamDataUnits.

Author:

Doug Gillespie

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BATTERYID
static java.lang.String	COMPASSID
short	dataVersion
static int	NET_PAM_COMMAND
static int	NET_PAM_COMMAND_PREPARE
static int	NET_PAM_COMMAND_START
static int	NET_PAM_COMMAND_STOP Some very basic commands to send straight through to receiving stations
static int	NET_PAM_DATA Flags for dataType1 - these must match equivalent commands in other network C++ code, so don't mess with them !
static int	NET_REMOTE_COMMAND
static int	NET_SPEED_DATA
static int	NET_SYSTEM_DATA
static int	SYSTEM_BATTERYDATA
static int	SYSTEM_COMPASSDATA
static int	SYSTEM_GPSDATA
static java.lang.String	unitTypeString

Constructor Summary

Constructors

Constructor and Description
NetworkReceiver(java.lang.String unitName)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canClose() Called before Pamguard shuts down.
void	checkAcousticBuoyStats(BuoyStatusDataUnit buoyStatusDataUnit) If data units coming out of this buoy are acoustic, then it will need hydrophones.
javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
void	detectionDialog(java.awt.Frame parentFrame) Display the network dialog and act if things change.
BuoyStatusDataUnit	findBuoyStatusDataUnit(int buoyId1, int buoyId2, boolean create) Find buoy status data and optionally create it if it doesn't exist.
BuoyStatusDataBlock	getBuoyStatusDataBlock()
NetworkReceiveParams	getNetworkReceiveParams()
networkTransfer.receive.NetworkReceiver.NetworkReceiveProcess	getNetworkReceiveProcess()
static java.lang.String	getPamCommandString(int command)
int	getRecentDataBytes()
int	getRecentPackets()
java.util.ArrayList<PamDataBlock>	getRxDataBlocks()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
PamSidePanel	getSidePanel() Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel.
PamTabPanel	getTabPanel() Gets a reference to a panel to be added to a view
void	interpretData(java.net.Socket socket, short dataVersion2, short buoyId1, short buoyId2, short dataId1, int dataId2, int dataLen, byte[] duBuffer)
void	interpretPamData(java.net.Socket socket, short dataVersion2, BuoyStatusDataUnit buoyStatusDataUnit, short dataId1, int dataId2, int dataLen, byte[] duBuffer)
void	interpretSystemData(java.net.Socket socket, short dataVersion2, BuoyStatusDataUnit buoyStatusDataUnit, short dataId1, int dataId2, int dataLen, byte[] duBuffer)
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
void	pamClose() Called when PAMGUARD is finally closing down so that a module may free any remaining resources (e.g.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getTabClipCopier, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, stopViewerSound, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitName, getUnitType

Field Detail

dataVersion

public short dataVersion

unitTypeString

public static java.lang.String unitTypeString

NET_PAM_DATA

public static final int NET_PAM_DATA

Flags for dataType1 - these must match equivalent commands in other network C++ code, so don't mess with them !

See Also:

Constant Field Values

NET_REMOTE_COMMAND

public static final int NET_REMOTE_COMMAND

See Also:

Constant Field Values

NET_SPEED_DATA

public static final int NET_SPEED_DATA

See Also:

Constant Field Values

NET_SYSTEM_DATA

public static final int NET_SYSTEM_DATA

See Also:

Constant Field Values

NET_PAM_COMMAND

public static final int NET_PAM_COMMAND

See Also:

Constant Field Values

SYSTEM_GPSDATA

public static final int SYSTEM_GPSDATA

See Also:

Constant Field Values

SYSTEM_BATTERYDATA

public static final int SYSTEM_BATTERYDATA

See Also:

Constant Field Values

SYSTEM_COMPASSDATA

public static final int SYSTEM_COMPASSDATA

See Also:

Constant Field Values

NET_PAM_COMMAND_STOP

public static final int NET_PAM_COMMAND_STOP

Some very basic commands to send straight through to receiving stations

See Also:

Constant Field Values

NET_PAM_COMMAND_PREPARE

public static final int NET_PAM_COMMAND_PREPARE

See Also:

Constant Field Values

NET_PAM_COMMAND_START

public static final int NET_PAM_COMMAND_START

See Also:

Constant Field Values

COMPASSID

public static final java.lang.String COMPASSID

See Also:

Constant Field Values

BATTERYID

public static final java.lang.String BATTERYID

See Also:

Constant Field Values

Constructor Detail

NetworkReceiver

public NetworkReceiver(java.lang.String unitName)

Method Detail

getNetworkReceiveProcess

public networkTransfer.receive.NetworkReceiver.NetworkReceiveProcess getNetworkReceiveProcess()

getBuoyStatusDataBlock

public BuoyStatusDataBlock getBuoyStatusDataBlock()

Returns:

the buoyStatusDataBlock

getTabPanel

public PamTabPanel getTabPanel()

Description copied from class: PamControlledUnit

Gets a reference to a panel to be added to a view

Overrides:

getTabPanel in class PamControlledUnit

Returns:

reference to a PamTabPanel object

See Also:

PamTabPanel, PamSidePanel

getSidePanel

public PamSidePanel getSidePanel()

Description copied from class: PamControlledUnit

Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel. Side panels should be small since they are always visible and any space they take will be taken from the main tab panel.

It is possible for a PamControlled unit to have a side panel without having a pamTabPanel.

Overrides:

getSidePanel in class PamControlledUnit

Returns:

a pamSidePanel object.

See Also:

PamSidePanel, PamTabPanel

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from class: PamControlledUnit

General notification when the PAMGAURD model changes.

Overrides:

notifyModelChanged in class PamControlledUnit

Parameters:

changeType - type of change

createDetectionMenu

public javax.swing.JMenuItem createDetectionMenu(java.awt.Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with PamProcesses

Overrides:

createDetectionMenu in class PamControlledUnit

Parameters:

parentFrame - The owner frame of the menu

Returns:

reference to a JMenu which can be added to an existing menu or menu bar

Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

detectionDialog

public void detectionDialog(java.awt.Frame parentFrame)

Display the network dialog and act if things change.

Parameters:

parentFrame - parent frame to own dialog

getRecentPackets

public int getRecentPackets()

Returns:

the number of data packets received since the last call to this function

getRecentDataBytes

public int getRecentDataBytes()

Returns:

The total number of bytes received since the last call to this function

interpretData

public void interpretData(java.net.Socket socket,
                 short dataVersion2,
                 short buoyId1,
                 short buoyId2,
                 short dataId1,
                 int dataId2,
                 int dataLen,
                 byte[] duBuffer)

interpretSystemData

public void interpretSystemData(java.net.Socket socket,
                       short dataVersion2,
                       BuoyStatusDataUnit buoyStatusDataUnit,
                       short dataId1,
                       int dataId2,
                       int dataLen,
                       byte[] duBuffer)

interpretPamData

public void interpretPamData(java.net.Socket socket,
                    short dataVersion2,
                    BuoyStatusDataUnit buoyStatusDataUnit,
                    short dataId1,
                    int dataId2,
                    int dataLen,
                    byte[] duBuffer)

getPamCommandString

public static java.lang.String getPamCommandString(int command)

findBuoyStatusDataUnit

public BuoyStatusDataUnit findBuoyStatusDataUnit(int buoyId1,
                                        int buoyId2,
                                        boolean create)

Find buoy status data and optionally create it if it doesn't exist.

Parameters:

buoyId1 - buoy Id 1

buoyId2 - buoy Id 2

create - automatically create

Returns:

status data unit or null if not found.

checkAcousticBuoyStats

public void checkAcousticBuoyStats(BuoyStatusDataUnit buoyStatusDataUnit)

If data units coming out of this buoy are acoustic, then it will need hydrophones. Note that all this code needs to work with non acoustic data too - such as logger forms, in which case it wn' tbe necessary to have hydrophones.

Parameters:

buoyStatusDataUnit - status data.

getRxDataBlocks

public java.util.ArrayList<PamDataBlock> getRxDataBlocks()

Returns:

the rxDataBlocks

getNetworkReceiveParams

public NetworkReceiveParams getNetworkReceiveParams()

Returns:

the networkReceiveParams

getSettingsReference

public java.io.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

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

pamClose

public void pamClose()

Description copied from class: PamControlledUnit

Called when PAMGUARD is finally closing down so that a module may free any remaining resources (e.g. files or COMM ports).

Overrides:

pamClose in class PamControlledUnit

canClose

public boolean canClose()

Description copied from class: PamControlledUnit

Called before Pamguard shuts down. Rather than returning false, this function can be used as a final oportunity to save settings, write to the database, etc.

Overrides:

canClose in class PamControlledUnit

Returns:

true if OK for Pamguard to shut down, false otherwise.