clickDetector

Class ClickBinaryDataSource

java.lang.Object

binaryFileStorage.BinaryDataSource

clickDetector.ClickBinaryDataSource

public class ClickBinaryDataSource
extends BinaryDataSource

Class for storing clicks to binary store.

Author:

Doug Gillespie

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLICK_DETECTOR_CLICK Module version changes Version 2: Add int clickFlags after short clickType

Constructor Summary

Constructors

Constructor and Description
ClickBinaryDataSource(ClickDetector clickDetector, PamDataBlock sisterDataBlock, java.lang.String streamName)

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getModuleFooterData()
byte[]	getModuleHeaderData()
int	getModuleVersion() Get a version number for the module.
PackedBinaryObject	getPackedData(PamDataUnit pamDataUnit) Save a click to the binary data store
DataMapDrawing	getSpecialDrawing() REturn a class capable of overriding the normal drawing on the data map
java.lang.String	getStreamName()
int	getStreamVersion()
void	newFileOpened(java.io.File outputFile) Called from the BinaryOutputStream whenever a new output file is opened.
PamDataUnit	sinkData(BinaryObjectData binaryObjectData, BinaryHeader bh, int moduleVersion) Convert data read back in in viewer mode into the correct type of PamDataUnit.
ModuleFooter	sinkModuleFooter(BinaryObjectData binaryObjectData, BinaryHeader bh, ModuleHeader mh) Do something with module footer information
ModuleHeader	sinkModuleHeader(BinaryObjectData binaryObjectData, BinaryHeader bh) Do something with module header information

Methods inherited from class binaryFileStorage.BinaryDataSource

getBinaryStorageStream, getModuleName, getModuleType, getSisterDataBlock, isDoBinaryStore, isStoreData, reset, saveData, setBinaryStorageStream, setDoBinaryStore, setStoreData, storeData

Methods inherited from class java.lang.Object

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

Field Detail

CLICK_DETECTOR_CLICK

public static final int CLICK_DETECTOR_CLICK

Module version changes Version 2: Add int clickFlags after short clickType

See Also:

Constant Field Values

Constructor Detail

ClickBinaryDataSource

public ClickBinaryDataSource(ClickDetector clickDetector,
                     PamDataBlock sisterDataBlock,
                     java.lang.String streamName)

Method Detail

newFileOpened

public void newFileOpened(java.io.File outputFile)

Description copied from class: BinaryDataSource

Called from the BinaryOutputStream whenever a new output file is opened.

Specified by:

newFileOpened in class BinaryDataSource

Parameters:

outputFile - file information.

getModuleVersion

public int getModuleVersion()

Description copied from class: BinaryDataSource

Get a version number for the module.

This is different to the version number in the main file header and allows individual modules to update their format and maintain backwards compatibility with old data

Specified by:

getModuleVersion in class BinaryDataSource

Returns:

integer module version number

getModuleHeaderData

public byte[] getModuleHeaderData()

Specified by:

getModuleHeaderData in class BinaryDataSource

Returns:

Additional information (e.g. a control structure for a detector) to be stored in the Module Specific Control structure

getModuleFooterData

public byte[] getModuleFooterData()

Overrides:

getModuleFooterData in class BinaryDataSource

Returns:

data for the binary footer, or null.

getStreamName

public java.lang.String getStreamName()

Specified by:

getStreamName in class BinaryDataSource

Returns:

Stream name to be stored in the file header

getStreamVersion

public int getStreamVersion()

Specified by:

getStreamVersion in class BinaryDataSource

Returns:

Stream version name to be stored in the Module Specific Control structure

getPackedData

public PackedBinaryObject getPackedData(PamDataUnit pamDataUnit)

Save a click to the binary data store

Specified by:

getPackedData in class BinaryDataSource

Parameters:

cd - click detection

Returns:

packed binary data object

sinkModuleHeader

public ModuleHeader sinkModuleHeader(BinaryObjectData binaryObjectData,
                            BinaryHeader bh)

Description copied from class: BinaryDataSource

Do something with module header information

Specified by:

sinkModuleHeader in class BinaryDataSource

Parameters:

binaryObjectData - data for the module header.

bh - Binary header information

sinkModuleFooter

public ModuleFooter sinkModuleFooter(BinaryObjectData binaryObjectData,
                            BinaryHeader bh,
                            ModuleHeader mh)

Description copied from class: BinaryDataSource

Do something with module footer information

Specified by:

sinkModuleFooter in class BinaryDataSource

Parameters:

binaryObjectData - data for the module header.

bh - Binary header information

sinkData

public PamDataUnit sinkData(BinaryObjectData binaryObjectData,
                   BinaryHeader bh,
                   int moduleVersion)

Description copied from class: BinaryDataSource

Convert data read back in in viewer mode into the correct type of PamDataUnit.

DO NOT add this unit directly to the datablock, but pass it back to the calling process which will add it to the datablock if necessary.

Specified by:

sinkData in class BinaryDataSource

Parameters:

binaryObjectData - Binary data read back from a file.

bh - binary header from start of file.

Returns:

the PamDataUnit created from these data

getSpecialDrawing

public DataMapDrawing getSpecialDrawing()

Description copied from class: BinaryDataSource

REturn a class capable of overriding the normal drawing on the data map

Overrides:

getSpecialDrawing in class BinaryDataSource

Returns:

null if nothign exists.