likelihoodDetectionModule.thresholdDetector

Interface FilteredConsumer

All Known Implementing Classes:

FilteredDetectionWriter, TestConsumer

public interface FilteredConsumer

This interface abstracts the consumer of filtered event objects. This could represent a display widget, a file writer, a database writer, etc.

Author:

Dave Flogeras

Method Summary

Methods

Modifier and Type	Method and Description
void	endDetection(DetectionKey key) This method is called to end an existing detection pre-condition: startDetection has been previously called with the same channelMask/band.
void	startDetection(DetectionKey key) This method is called when a new detection starts on the given channel and band
boolean	updateDetection(DetectionKey key, NormalizedDataUnit ndu) This method is called to append a DetectionEvent to a running detection pre-condition: startDetection has been called for the given key (channelMask and band) At least one update will be given per detection.

Method Detail

startDetection

void startDetection(DetectionKey key)

This method is called when a new detection starts on the given channel and band

Parameters:

key - The key associated with the starting detection

updateDetection

boolean updateDetection(DetectionKey key,
                      NormalizedDataUnit ndu)

This method is called to append a DetectionEvent to a running detection pre-condition: startDetection has been called for the given key (channelMask and band) At least one update will be given per detection.

Parameters:

key - The key of the detection

ndu - The data for the update.

Returns:

true if successfully updates, false otherwise (ie. an event arrived for a channelMask/band that wasn't previously started

endDetection

void endDetection(DetectionKey key)

This method is called to end an existing detection pre-condition: startDetection has been previously called with the same channelMask/band. Ignores the request if the key had not been started.

Parameters:

key - The key associated with the ending detection.