org.freehep.jas.extension.tupleExplorer.cut
Class AbstractCutVariable

java.lang.Object
  extended by org.freehep.jas.extension.tupleExplorer.cut.AbstractCutVariable
All Implemented Interfaces:
CutVariable
Direct Known Subclasses:
Numeric1DCutVariable

public abstract class AbstractCutVariable
extends Object
implements CutVariable

AbstractCutVariable the abstract implementation of CutVariable

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

Field Summary
 
Fields inherited from interface org.freehep.jas.extension.tupleExplorer.cut.CutVariable
CUTVARIABLE_LOCKED, CUTVARIABLE_UNLOCKED
 
Constructor Summary
AbstractCutVariable(String cutVarName)
          Create a new AbstractCutVariable object
AbstractCutVariable(String cutVarName, CutDataSet cutDataSet)
          Create a new AbstractCutVariable object
 
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 setMax(double upperBound)
          Set the upper bound of the range
 void setMin(double lowerBound)
          Set the lower bound of the range
 void setName(String cutVarName)
          Set the name of the CutVariable
 void setRange(double lowerBound, double upperBound)
          Set the CutVariable range.
 void setState(int cutVarState)
          Set the state of the CutVariable
 void setValue(double cutVarValue)
          Set the current value of the AbstrctCutVariable.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractCutVariable

public AbstractCutVariable(String cutVarName)
Create a new AbstractCutVariable object

Parameters:
cutVarName - the name of the cut variable

AbstractCutVariable

public AbstractCutVariable(String cutVarName,
                           CutDataSet cutDataSet)
Create a new AbstractCutVariable object

Parameters:
cutVarName - the name of the cut variable
cutDataSet - the CutDataSet data set
Method Detail

setName

public void setName(String cutVarName)
Set the name of the CutVariable

Parameters:
cutVarName - the name of the CutVariable

getName

public String getName()
Get the name of the CutVariable

Specified by:
getName in interface CutVariable
Returns:
the name of the CutVariable

setRange

public void setRange(double lowerBound,
                     double upperBound)
Set the CutVariable range.

Parameters:
lowerBound - the lower bound of the range
upperBound - the upper bound of the range

getMin

public double getMin()
Get the lower bound of the range

Specified by:
getMin in interface CutVariable
Returns:
the lower bound of the range

getMax

public double getMax()
Get the upper bound of the range

Specified by:
getMax in interface CutVariable
Returns:
the upper bound of the range

setMin

public void setMin(double lowerBound)
Set the lower bound of the range

Parameters:
lowerBound - the lower bound of the range

setMax

public void setMax(double upperBound)
Set the upper bound of the range

Parameters:
upperBound - the upper bound of the range

setState

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

Specified by:
setState in interface CutVariable
Parameters:
cutVarState - the state of the CutVariable

getState

public int getState()
Get the state of the CutVariable

Specified by:
getState in interface CutVariable
Returns:
the state of the CutVariable

isLocked

public boolean isLocked()
Check if the CutVariable is locked

Specified by:
isLocked in interface CutVariable
Returns:
true<\code> if the variable is locked false<\code> otherwise

setValue

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

Specified by:
setValue in interface CutVariable
Parameters:
cutVarValue - the current value of the CutVariable

getValue

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

Specified by:
getValue in interface CutVariable
Returns:
the current value of the CutVariable

getValueChange

public double getValueChange()
Get the CutVariable change in its value

Specified by:
getValueChange in interface CutVariable
Returns:
the change in the CutVariable's value

setCutDataSet

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

Specified by:
setCutDataSet in interface CutVariable
Parameters:
cutDataSet - the CutDataSet data set

getCutDataSet

public CutDataSet getCutDataSet()
Get the CutDataSet corresponding to this CutVariable

Specified by:
getCutDataSet in interface CutVariable
Returns:
the CutDataSet

addCutVariableListener

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

Specified by:
addCutVariableListener in interface CutVariable
Parameters:
cutVarListener - the CutVariableListenere to add

removeCutVariableListener

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

Specified by:
removeCutVariableListener in interface CutVariable
Parameters:
cutVarListener - the CutVariableListenere to remove

getCutVariableGUIListener

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

Specified by:
getCutVariableGUIListener in interface CutVariable
Returns:
the CutVariableGUIListener


Copyright © 2013. All Rights Reserved.