xal.tools.correlator

Class CorrelationStack<RecordType>

java.lang.Object

xal.tools.correlator.CorrelationStack<RecordType>

public class CorrelationStack<RecordType>
extends java.lang.Object

CorrelationStack is a correlator utility that uses a fixed sized, buffer to collect correlations from a correlator. An external object can then request all or the oldest correlations in which case the retrieved correlations are removed from the buffer. Hence the CorrelationStack is a LILO stack. CorrelationStack runs the correlator in "patient" mode (PatientBroadcaster), so the correlator posts mutually exclusive correlations each of which has passed the filter tests.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedList<Correlation<RecordType>>	buffer buffer is a LILO stack of correlations with the oldest correlations having the smallest indices.
protected Correlator<?,RecordType,?>	correlator Correlator
protected Correlation<RecordType>	lastCorrelation
protected int	stackSize

Constructor Summary

Constructors

Constructor and Description
CorrelationStack(Correlator<?,RecordType,?> aCorrelator, int aStackSize) Creates a new instance of CorrelationStack

Method Summary

Modifier and Type	Method and Description
void	clearBuffer() Empty all correlations from the buffer.
int	getCorrelationCount() Get the number of correlations on the stack.
boolean	isEmpty() Determines whether there are any correlations left on the stack.
java.util.List<Correlation<RecordType>>	popAllCorrelations() Pop all correlations from the stack.
Correlation<RecordType>	popCorrelation() Removes the oldest correlation in the buffer and returns it.
protected void	push(Correlation<RecordType> correlation) Push a correlation onto the stack.
protected void	trimBuffer() Trim the buffer down to the stackSize by removing the oldest correlations.

Methods inherited from class java.lang.Object

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

Field Detail

buffer

protected java.util.LinkedList<Correlation<RecordType>> buffer

buffer is a LILO stack of correlations with the oldest correlations having the smallest indices.

stackSize

protected int stackSize

lastCorrelation

protected Correlation<RecordType> lastCorrelation

correlator

protected Correlator<?,RecordType,?> correlator

Correlator

Constructor Detail

CorrelationStack

public CorrelationStack(Correlator<?,RecordType,?> aCorrelator,
                        int aStackSize)

Creates a new instance of CorrelationStack

Method Detail

getCorrelationCount

public int getCorrelationCount()

Get the number of correlations on the stack.

Returns:

The number of correlations on the stack.

isEmpty

public boolean isEmpty()

Determines whether there are any correlations left on the stack.

Returns:

true if there are no correlations on the stack and false otherwise.

clearBuffer

public void clearBuffer()

Empty all correlations from the buffer.

popCorrelation

public Correlation<RecordType> popCorrelation()
                                       throws java.util.NoSuchElementException

Removes the oldest correlation in the buffer and returns it.

Returns:

The oldest correlation on the stack.

Throws:

java.util.NoSuchElementException - if there are no correlations on the stack.

popAllCorrelations

public java.util.List<Correlation<RecordType>> popAllCorrelations()

Pop all correlations from the stack.

Returns:

all correlations on the stack.

push

protected void push(Correlation<RecordType> correlation)

Push a correlation onto the stack.

Parameters:

correlation - The correlation to push onto the stack.

trimBuffer

protected void trimBuffer()

Trim the buffer down to the stackSize by removing the oldest correlations.