org.hps.analysis.trigger.util

Class Trigger<E>

java.lang.Object

org.hps.analysis.trigger.util.Trigger<E>

Direct Known Subclasses:

SinglesTrigger

public abstract class Trigger<E>
extends Object

Class Trigger stores a set cut states indicating whether specific cut conditions associated with a trigger were met or not as well as the state of the overall trigger. It is the responsibility of implementing classes to specify the supported cut states and also to define when the trigger conditions are met.

Author:

Kyle McCarty

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Boolean>	passMap
private boolean	passTrigger
private E	source
private int	triggerNum

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Trigger(E source) Creates a new Trigger object with the argument specifying the object from whence the trigger state is derived.
protected	Trigger(E source, int triggerNum) Creates a new Trigger object with the argument specifying the object from whence the trigger state is derived.

Method Summary

Modifier and Type	Method and Description
protected void	addValidCut(String cut) Adds a cut to the set of cuts tracked by this trigger.
protected boolean	getCutState(String cut) Gets the state of the specified cut.
int	getTriggerNumber() Gets the number of the trigger.
E	getTriggerSource() Gets the object to which the trigger cuts are applied.
boolean	getTriggerState() Gets whether the conditions for the trigger were met.
private boolean	isValidTrigger() Checks whether the all of the trigger cut conditions were met.
protected void	removeValidCut(String cut) Removes a cut from the set of cuts tracked by the trigger.
protected void	setCutState(String cut, boolean state) Sets whether the conditions for the specified cut were met.
protected boolean	supportsCut(String cut) Indicates whether the specified cut state is tracked by this object or not.

Methods inherited from class java.lang.Object

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

Field Detail

passTrigger

private boolean passTrigger

passMap

private Map<String,Boolean> passMap

source

private final E source

triggerNum

private final int triggerNum

Constructor Detail

Trigger

protected Trigger(E source)

Creates a new Trigger object with the argument specifying the object from whence the trigger state is derived.

Parameters:

source - - The trigger source object.

Trigger

protected Trigger(E source,
                  int triggerNum)

Creates a new Trigger object with the argument specifying the object from whence the trigger state is derived.

Parameters:

source - - The trigger source object.

triggerNum - - The number of the trigger.

Method Detail

addValidCut

protected void addValidCut(String cut)

Adds a cut to the set of cuts tracked by this trigger.

Parameters:

cut - - The identifier for the cut.

getCutState

protected boolean getCutState(String cut)
                       throws IllegalArgumentException

Gets the state of the specified cut.

Parameters:

cut - - The identifier for the cut.

Returns:

Returns true if the conditions for the specified cut were met and false otherwise.

Throws:

IllegalArgumentException - Occurs if the specified cut is not supported by the object.

getTriggerNumber

public int getTriggerNumber()

Gets the number of the trigger. If the trigger has no number, it will return -1.

Returns:

Returns the trigger number as an int.

getTriggerSource

public E getTriggerSource()

Gets the object to which the trigger cuts are applied.

Returns:

Returns the trigger source object.

getTriggerState

public boolean getTriggerState()

Gets whether the conditions for the trigger were met.

Returns:

Returns true if the conditions for the trigger were met and false if they were not.

removeValidCut

protected void removeValidCut(String cut)

Removes a cut from the set of cuts tracked by the trigger.

Parameters:

cut - - The identifier for the cut.

isValidTrigger

private boolean isValidTrigger()

Checks whether the all of the trigger cut conditions were met.

Returns:

Returns true if all of the cut conditions were met and false otherwise.

setCutState

protected void setCutState(String cut,
                           boolean state)
                    throws IllegalArgumentException

Sets whether the conditions for the specified cut were met.

Parameters:

cut - - The identifier for the cut.

state - - true indicates that the conditions for the cut were met and false that they were not.

Throws:

IllegalArgumentException - Occurs if the specified cut is not supported by the object.

supportsCut

protected boolean supportsCut(String cut)

Indicates whether the specified cut state is tracked by this object or not.

Parameters:

cut - - The identifier for the cut.

Returns:

Returns true if the cut state is tracked by this object and false otherwise.