decimator

Class DecimatorControl

java.lang.Object

PamController.PamControlledUnit

decimator.DecimatorControl

All Implemented Interfaces:

OfflineDataStore, OfflineRawDataStore, PamSettings

public class DecimatorControl
extends PamControlledUnit
implements PamSettings, OfflineRawDataStore

Author:

Doug Gillespie Quite a simple control unit that filters and decimates raw data producing a new data stream

Needs a control dialog

Constructor Summary

Constructors

Constructor and Description
DecimatorControl(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
void	createOfflineDataMap(java.awt.Window parentFrame) Create a basic map of the data including first and last times and some kind of data/unit time count plus ideally some kind of start and stop time list of where there are gaps in the data.
DatagramManager	getDatagramManager()
java.lang.String	getDataSourceName() Get the data source name
OfflineFileServer	getOfflineFileServer()
PamProcess	getParentProcess()
PamRawDataBlock	getRawDataBlock()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
boolean	loadData(PamDataBlock dataBlock, long dataStart, long dataEnd, RequestCancellationObject cancellationObject, ViewLoadObserver loadObserver) Load data for a given datablock between two time limits.
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
boolean	rewriteIndexFile(PamDataBlock dataBlock, OfflineDataMapPoint dmp) Moved this function over from binary data store.
boolean	saveData(PamDataBlock dataBlock) Save data previously loaded from the store during offline viewing.
void	setupControlledUnit() called for all PamControlledUnits after all units have been created.

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, 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

Methods inherited from interface PamController.OfflineRawDataStore

getUnitName

Constructor Detail

DecimatorControl

public DecimatorControl(java.lang.String name)

Method Detail

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.

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

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

setupControlledUnit

public void setupControlledUnit()

Description copied from class: PamControlledUnit

called for all PamControlledUnits after all units have been created. This is a good time for the controlled units and processes to find and check their source data and the configuration generally since most onjects (i.e. output data blocks) should be in place

Overrides:

setupControlledUnit in class PamControlledUnit

createOfflineDataMap

public void createOfflineDataMap(java.awt.Window parentFrame)

Description copied from interface: OfflineDataStore

Create a basic map of the data including first and last times and some kind of data/unit time count plus ideally some kind of start and stop time list of where there are gaps in the data.

Specified by:

createOfflineDataMap in interface OfflineDataStore

getDataSourceName

public java.lang.String getDataSourceName()

Description copied from interface: OfflineDataStore

Get the data source name

Specified by:

getDataSourceName in interface OfflineDataStore

Returns:

data source name

loadData

public boolean loadData(PamDataBlock dataBlock,
               long dataStart,
               long dataEnd,
               RequestCancellationObject cancellationObject,
               ViewLoadObserver loadObserver)

Description copied from interface: OfflineDataStore

Load data for a given datablock between two time limits.

Specified by:

loadData in interface OfflineDataStore

Parameters:

dataBlock - datablock owner of the data

dataStart - start time in milliseconds

dataEnd - end time in milliseconds

Returns:

true if load successful.

saveData

public boolean saveData(PamDataBlock dataBlock)

Description copied from interface: OfflineDataStore

Save data previously loaded from the store during offline viewing.

Specified by:

saveData in interface OfflineDataStore

Parameters:

dataBlock - datablock owner of the data

Returns:

true if saved or save not needed. False if an error prevents saving.

getOfflineFileServer

public OfflineFileServer getOfflineFileServer()

Specified by:

getOfflineFileServer in interface OfflineRawDataStore

Returns:

The offline file server which will do the actual work

getParentProcess

public PamProcess getParentProcess()

Specified by:

getParentProcess in interface OfflineRawDataStore

getRawDataBlock

public PamRawDataBlock getRawDataBlock()

Specified by:

getRawDataBlock in interface OfflineRawDataStore

rewriteIndexFile

public boolean rewriteIndexFile(PamDataBlock dataBlock,
                       OfflineDataMapPoint dmp)

Description copied from interface: OfflineDataStore

Moved this function over from binary data store. Many storage systems may notbe able to do this, but some might !

Specified by:

rewriteIndexFile in interface OfflineDataStore

Returns:

getDatagramManager

public DatagramManager getDatagramManager()

Specified by:

getDatagramManager in interface OfflineDataStore

Returns:

the datagramManager