org.jlab.coda.eventViewer

Class EtHandler

java.lang.Object

org.jlab.coda.eventViewer.EtHandler

public class EtHandler
extends java.lang.Object

This class handles communications with an ET system - including creating a panel to do so through the GUI - in order to get ET events which are parsed into evio events.

Author:

Timmer Feb 25, 2013

Constructor Summary

Constructors

Constructor and Description
EtHandler()

Method Summary

Modifier and Type	Method and Description
void	addEvent(org.jlab.coda.jevio.EvioEvent event) Add the given event to the event list.
void	clearList() Clear the entire event list - all events.
void	clearList(int numberToDelete) Clear the specified number of latest events from the list.
javax.swing.JPanel	createEtPanel() Create the panel/menu-item used to handle communications with an ET system.
int	getCurrentEventIndex() Get the index of the current event (starting at 0).
org.jlab.coda.hipo.CompressionType	getDataCompressionType() Get the compression type of data being viewed.
org.jlab.coda.jevio.EvioEvent	getEvent(int index) Get the specified event, index beginning at 1.
Filter	getEventFilter() Get the event filter to use on each event before adding to list.
int	getEvioVersion() Get the evio version of data being viewed.
int	getListLimit() Get the maximum number of events that the list will hold.
int	getListSize() Get the size of the event list.
org.jlab.coda.jevio.EvioEvent	getNextEvent() Get the next evio event from the list or null if none.
org.jlab.coda.jevio.EvioEvent	getPrevEvent() Get the previous evio event from the list or null if none.
boolean	hasNextEvent() Is there another evio event, after the one previously obtained, in the list?
void	resetCurrentEventIndex() Reset the index of the current event to -1.
void	setEventFilter(Filter eventFilter) Set the event filter to use on each event before adding to list.
void	setEventNum(int eventNum) Set the event number.
void	setListLimit(int limit) Set the maximum number of events that the list will hold.
void	startFillingEventList() Create and start a thread to process ET events into Evio events.
void	stopFillingEventList() Stop the thread processing ET events into Evio events, if any.

Methods inherited from class java.lang.Object

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

Constructor Detail

EtHandler

public EtHandler()

Method Detail

getEvioVersion

public int getEvioVersion()

Get the evio version of data being viewed.

Returns:

evio version of data being viewed.

getDataCompressionType

public org.jlab.coda.hipo.CompressionType getDataCompressionType()

Get the compression type of data being viewed.

Returns:

compression type of data being viewed.

getEventFilter

public Filter getEventFilter()

Get the event filter to use on each event before adding to list.

Returns:

the event filter to use on each event before adding to list.

setEventFilter

public void setEventFilter(Filter eventFilter)

Set the event filter to use on each event before adding to list.

Parameters:

eventFilter - filter to use on each event before adding to list.

addEvent

public void addEvent(org.jlab.coda.jevio.EvioEvent event)

Add the given event to the event list. If the list is full, nothing is added.

Parameters:

event - Evio event to add to event list.

getEvent

public org.jlab.coda.jevio.EvioEvent getEvent(int index)

Get the specified event, index beginning at 1.

Parameters:

index - index into event list beginning at 1.

Returns:

EvioEvent object at given index in event list; or null if no object at that index

getNextEvent

public org.jlab.coda.jevio.EvioEvent getNextEvent()

Get the next evio event from the list or null if none.

Returns:

next evio event from the list or null if none.

hasNextEvent

public boolean hasNextEvent()

Is there another evio event, after the one previously obtained, in the list?

Returns:

true if there is an event, after the one previously obtained, in the list, else false.

getPrevEvent

public org.jlab.coda.jevio.EvioEvent getPrevEvent()

Get the previous evio event from the list or null if none.

Returns:

previous evio event from the list or null if none.

getListSize

public int getListSize()

Get the size of the event list.

Returns:

size of the event list.

getCurrentEventIndex

public int getCurrentEventIndex()

Get the index of the current event (starting at 0). Used to determine what is next and what is previous.

Returns:

index of the current event (starting at 0).

resetCurrentEventIndex

public void resetCurrentEventIndex()

Reset the index of the current event to -1. Used to determine what is next and what is previous.

setEventNum

public void setEventNum(int eventNum)

Set the event number. Newly added events have numbers starting with the given value.

Parameters:

eventNum - newly added events have numbers starting with this value

clearList

public void clearList()

Clear the entire event list - all events.

clearList

public void clearList(int numberToDelete)

Clear the specified number of latest events from the list.

Parameters:

numberToDelete - number of latest events to delete from the list.

getListLimit

public int getListLimit()

Get the maximum number of events that the list will hold.

Returns:

maximum number of events that the list will hold.

setListLimit

public void setListLimit(int limit)

Set the maximum number of events that the list will hold. Does nothing if limit < 1. Will set it to a max of 1000. If reducing the size of the current limit, it will clear any events beyond the new limit.

Parameters:

limit - maximum number of events that the list will hold.

startFillingEventList

public void startFillingEventList()

Create and start a thread to process ET events into Evio events.

stopFillingEventList

public void stopFillingEventList()

Stop the thread processing ET events into Evio events, if any.

createEtPanel

public javax.swing.JPanel createEtPanel()

Create the panel/menu-item used to handle communications with an ET system.

Returns:

the panel/menu-item used to handle communications with an ET system.