org.jlab.coda.eventViewer

Enum Filter

java.lang.Object

java.lang.Enum<Filter>

org.jlab.coda.eventViewer.Filter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Filter>

public enum Filter
extends java.lang.Enum<Filter>

This enum contains the choices for a filter which allows the described evio events into the event viewer.

Author:

timmer Mar 19, 2013

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTROL Allow only CODA control events.
EVERY Allow all.
PARTIAL Allow only CODA partially-built physics events.
PHYSICS Allow only CODA physics events.
ROC_RAW Allow only CODA ROC raw events.

Method Summary

Modifier and Type	Method and Description
static boolean	allow(org.jlab.coda.jevio.EvioEvent event) Filter to apply to Evio events.
boolean	allow2(org.jlab.coda.jevio.EvioEvent event) Filter to apply to Evio events.
boolean	isActive()
void	setActive(boolean active)
void	setTriggerType(int triggerType) Set the value of the trigger type which is allowed by this filter in Physics events.
static Filter	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Filter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EVERY

public static final Filter EVERY

Allow all. Default filtering.

PHYSICS

public static final Filter PHYSICS

Allow only CODA physics events.

PARTIAL

public static final Filter PARTIAL

Allow only CODA partially-built physics events.

CONTROL

public static final Filter CONTROL

Allow only CODA control events.

ROC_RAW

public static final Filter ROC_RAW

Allow only CODA ROC raw events.

Method Detail

values

public static Filter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Filter c : Filter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Filter valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

setTriggerType

public void setTriggerType(int triggerType)

Set the value of the trigger type which is allowed by this filter in Physics events.

Parameters:

triggerType - value of the trigger type which is allowed by this filter in Physics events.

allow

public static boolean allow(org.jlab.coda.jevio.EvioEvent event)

Filter to apply to Evio events.

Parameters:

event - evio event to be examined

Returns:

true if event is allowed into viewer, else false.

allow2

public boolean allow2(org.jlab.coda.jevio.EvioEvent event)

Filter to apply to Evio events.

Parameters:

event - evio event to be examined

Returns:

true if event is allowed into viewer, else false.