xal.ca.correlator

Class ChannelAgent

java.lang.Object

xal.tools.correlator.SourceAgent<ChannelTimeRecord>

xal.ca.correlator.ChannelAgent

public class ChannelAgent
extends SourceAgent<ChannelTimeRecord>

ChannelAgent manages a single channel. It performs any setup, monitors the channel and it manages a circular buffer of bin agents that gather correlated events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ChannelAgent.EventHandler Handle the monitor events
protected class	ChannelAgent.FilteredEventHandler Handle the Monitor events and filter the events according to the supplied ChannelRecordFilter.

Field Summary

Fields inherited from class xal.tools.correlator.SourceAgent

_binUpdateProxy

Constructor Summary

Constructors

Constructor and Description
ChannelAgent(MessageCenter localCenter, Channel newChannel, java.lang.String newName, RecordFilter<ChannelTimeRecord> recordFilter, CorrelationTester<ChannelTimeRecord> tester) Creates new ChannelAgent

Method Summary

Modifier and Type	Method and Description
boolean	isActive() Determine if the channel is actively being monitored.
boolean	isEnabled() Determine if the channel is enabled for correlations.
protected void	makeMonitor() Create a monitor to listen for new channel records.
protected void	setupEventHandler(RecordFilter<ChannelTimeRecord> recordFilter) Setup the event handler to use the specified record filter to filter monitor events for this channel.
boolean	startMonitor() Start monitoring the channel.
void	stopMonitor() Stop monitoring the channel

Methods inherited from class xal.tools.correlator.SourceAgent

binTimespanChanged, correlationFilterChanged, name, postEvent, reset, setBinTimespan, shutdown, sourceAdded, sourceRemoved, willStartMonitoring, willStopMonitoring

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelAgent

public ChannelAgent(MessageCenter localCenter,
                    Channel newChannel,
                    java.lang.String newName,
                    RecordFilter<ChannelTimeRecord> recordFilter,
                    CorrelationTester<ChannelTimeRecord> tester)

Creates new ChannelAgent

Parameters:

localCenter - local shared message center

newChannel - channel to monitor

newName - name

recordFilter - filter for records

tester - correlation tester

Method Detail

setupEventHandler

protected void setupEventHandler(RecordFilter<ChannelTimeRecord> recordFilter)

Setup the event handler to use the specified record filter to filter monitor events for this channel.

Specified by:

setupEventHandler in class SourceAgent<ChannelTimeRecord>

Parameters:

recordFilter - The filter to use for this channel.

See Also:

SourceAgent.postEvent(RecordType, double)

isEnabled

public boolean isEnabled()

Determine if the channel is enabled for correlations.

Returns:

true if the channel is enabled for correlations.

isActive

public boolean isActive()

Determine if the channel is actively being monitored.

Returns:

true if the channel is being monitored and false otherwise.

startMonitor

public boolean startMonitor()

Start monitoring the channel.

Specified by:

startMonitor in class SourceAgent<ChannelTimeRecord>

Returns:

true if the channel is successfully being monitored and false otherwise.

stopMonitor

public void stopMonitor()

Stop monitoring the channel

Specified by:

stopMonitor in class SourceAgent<ChannelTimeRecord>

makeMonitor

protected void makeMonitor()

Create a monitor to listen for new channel records.