|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TnMetric
This interface defines the minimum elements for any class that calculates a metric in the TnToolkit. That is, it must define a method to process input as part of is calculation. It must also allow other objects to monitor its progress, and if necessary cancel it.
Method Summary | |
---|---|
void |
cancel()
Signals calculation of this metric to stop. |
boolean |
cancelled()
Returns whether or not cancel() was called on this metric. |
float |
getProgress()
Returns a float in the range [0..1], representing the
progress of the process() method. |
void |
process()
Performs the required calculations and actions to determine the value and result of this metric. |
Method Detail |
---|
void process()
void cancel()
boolean cancelled()
cancel()
was called on this metric.
true
iff cancel()
was called on this
metric object.cancel()
float getProgress()
float
in the range [0..1], representing the
progress of the process()
method.
float
in the range [0..1], representing the
progress of the process()
method.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |