org.freehep.jas.extension.tupleExplorer.cut
Interface Cut

All Known Subinterfaces:
CutWithVariables
All Known Implementing Classes:
AbstractCut, AbstractCutWithVariables, CutSet, JELCut, MutableTupleTreeCut, MutableTupleTreeCutSet, Numeric1DCut

public interface Cut

A Cut either accepts or rejects an CutData data set

Version:
$Id: Cut.java 13893 2011-09-28 23:42:34Z tonyj $
Author:
The FreeHEP team @ SLAC.

Nested Class Summary
static class Cut.CutGUIListener
          Internal class that implements the behavior of CutListener.
 
Field Summary
static int CUT_DISABLED
           
static int CUT_DISABLED_INVERTED
           
static int CUT_ENABLED
          The Cut can be in any of the following three states: enabled, disabled or iverted.
static int CUT_INVERTED
           
 
Method Summary
 boolean accept(hep.aida.ref.tuple.FTupleCursor cutDataCursor)
          Apply the cut to the CutDataSet.
 void addCutListener(CutListener cutListener)
          Add a CutListener to the Cut
 CutDataSet getCutDataSet()
          Get the CutDataSet on which the cut is applied
 CutListener getCutGUIListener()
          Get the CutGUIListener that listens to the GUI representations of the Cut.
 EventListenerList getCutListeners()
          Get the list of CutListeners listening to this Cut
 String getName()
          Get the name of the Cut
 int getState()
          Get the state of the Cut.
 void invert()
          Invert the cut.
 boolean isEnabled()
          Check if the Cut is enabled
 boolean isInverted()
          Check if the Cut is inverted
 void removeCutListener(CutListener cutListener)
          Remove a CutListener from the Cut
 void setCutDataSet(CutDataSet cutDataSet)
          Set the CutDataSet on which the cut is applied
 void setDisabled(boolean isDisabled)
          Disable the cut.
 void setName(String cutName)
          Set the name of the Cut
 void setState(int cutState)
          Set the state of the Cut.
 

Field Detail

CUT_ENABLED

static final int CUT_ENABLED
The Cut can be in any of the following three states: enabled, disabled or iverted. The "inverted" state corresponds to the logical NOT (!).

See Also:
Constant Field Values

CUT_INVERTED

static final int CUT_INVERTED
See Also:
Constant Field Values

CUT_DISABLED

static final int CUT_DISABLED
See Also:
Constant Field Values

CUT_DISABLED_INVERTED

static final int CUT_DISABLED_INVERTED
See Also:
Constant Field Values
Method Detail

getName

String getName()
Get the name of the Cut

Returns:
the name of the Cut

setName

void setName(String cutName)
Set the name of the Cut

Parameters:
cutName - the name of the Cut

invert

void invert()
Invert the cut.


setDisabled

void setDisabled(boolean isDisabled)
Disable the cut.


getState

int getState()
Get the state of the Cut.

Returns:
the state of the Cut

setState

void setState(int cutState)
Set the state of the Cut.

Parameters:
cutState - the state of the Cut

isEnabled

boolean isEnabled()
Check if the Cut is enabled

Returns:
true<\code> if the cut is enabled false<\code> otherwise

isInverted

boolean isInverted()
Check if the Cut is inverted

Returns:
true<\code> if the cut is inverted false<\code> otherwise

getCutDataSet

CutDataSet getCutDataSet()
Get the CutDataSet on which the cut is applied

Returns:
the CutDataSet.

setCutDataSet

void setCutDataSet(CutDataSet cutDataSet)
Set the CutDataSet on which the cut is applied

Parameters:
cutDataSet - the CutDataSet.

accept

boolean accept(hep.aida.ref.tuple.FTupleCursor cutDataCursor)
Apply the cut to the CutDataSet.

Parameters:
cutDataCursor - the CutDataCursor to access the CutDataSet current value
Returns:
true<\code> if the current value of the CutDataSet is accepted by the cut false<\code> otherwise

addCutListener

void addCutListener(CutListener cutListener)
Add a CutListener to the Cut

Parameters:
cutListener - the CutListener to add

removeCutListener

void removeCutListener(CutListener cutListener)
Remove a CutListener from the Cut

Parameters:
cutListener - the CutListenere to remove

getCutListeners

EventListenerList getCutListeners()
Get the list of CutListeners listening to this Cut

Returns:
the list of CutListeners

getCutGUIListener

CutListener getCutGUIListener()
Get the CutGUIListener that listens to the GUI representations of the Cut.

Returns:
the CutGUIListener


Copyright © 2013. All Rights Reserved.