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

All Known Implementing Classes:
AbstractCutVariable, Numeric1DCutVariable

public interface CutVariable

A CutVariable is a variable of a Cut

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

Nested Class Summary
static class CutVariable.CutVariableGUIListener
          Internal class that implements the behavior of CutVariableListener.
 
Field Summary
static int CUTVARIABLE_LOCKED
           
static int CUTVARIABLE_UNLOCKED
          The CutVariable can be either locked or unlocked.
 
Method Summary
 void addCutVariableListener(CutVariableListener cutVarListener)
          Add a CutVariableListener to the CutVariable
 CutDataSet getCutDataSet()
          Get the CutDataSet corresponding to this CutVariable
 CutVariableListener getCutVariableGUIListener()
          Get the CutVariableGUIListener that listens to the GUI representations of the CutVariable.
 double getMax()
          Get the upper bound of the range
 double getMin()
          Get the lower bound of the range
 String getName()
          Get the name of the CutVariable
 int getState()
          Get the state of the CutVariable
 double getValue()
          Get the current value of the CutVariable.
 double getValueChange()
          Get the CutVariable change in its value
 boolean isLocked()
          Check if the CutVariable is locked
 void removeCutVariableListener(CutVariableListener cutVarListener)
          Remove a CutVariableListener from the CutVariable
 void setCutDataSet(CutDataSet cutDataSet)
          Assign to this CutVariable a CutDataSet.
 void setState(int cutVarState)
          Set the state of the CutVariable
 void setValue(double cutVarValue)
          Set the current value of the CutVariable.
 

Field Detail

CUTVARIABLE_UNLOCKED

static final int CUTVARIABLE_UNLOCKED
The CutVariable can be either locked or unlocked. Moreover it can be frozen when it reaches the boundary of the range or when it is synchronized with another CutVariable that is locked or frozen.

See Also:
Constant Field Values

CUTVARIABLE_LOCKED

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

getName

String getName()
Get the name of the CutVariable

Returns:
the name of the CutVariable

getMin

double getMin()
Get the lower bound of the range

Returns:
the lower bound of the range

getMax

double getMax()
Get the upper bound of the range

Returns:
the upper bound of the range

getState

int getState()
Get the state of the CutVariable

Returns:
the state of the CutVariable

setState

void setState(int cutVarState)
Set the state of the CutVariable

Parameters:
cutVarState - the state of the CutVariable

isLocked

boolean isLocked()
Check if the CutVariable is locked

Returns:
true<\code> if the variable is locked false<\code> otherwise

getValue

double getValue()
Get the current value of the CutVariable.

Returns:
the current value of the CutVariable

setValue

void setValue(double cutVarValue)
Set the current value of the CutVariable.

Parameters:
cutVarValue - the current value of the CutVariable

getValueChange

double getValueChange()
Get the CutVariable change in its value

Returns:
the change in the CutVariable's value

addCutVariableListener

void addCutVariableListener(CutVariableListener cutVarListener)
Add a CutVariableListener to the CutVariable

Parameters:
cutVarListener - the CutVariableListenere to add

removeCutVariableListener

void removeCutVariableListener(CutVariableListener cutVarListener)
Remove a CutVariableListener from the CutVariable

Parameters:
cutVarListener - the CutVariableListenere to remove

setCutDataSet

void setCutDataSet(CutDataSet cutDataSet)
Assign to this CutVariable a CutDataSet. The CutDataSet data set is used to set the CutVariable's range.

Parameters:
cutDataSet - the CutDataSet data set

getCutDataSet

CutDataSet getCutDataSet()
Get the CutDataSet corresponding to this CutVariable

Returns:
the CutDataSet

getCutVariableGUIListener

CutVariableListener getCutVariableGUIListener()
Get the CutVariableGUIListener that listens to the GUI representations of the CutVariable.

Returns:
the CutVariableGUIListener


Copyright © 2013. All Rights Reserved.