com.speckled.specksim.datagen
Interface Generator

All Superinterfaces:
java.lang.Runnable

public interface Generator
extends java.lang.Runnable

The runnable object that will carry out the data generation and write the output datafile

Author:
ryanm

Method Summary
 void addProgressListener(ProgressListener pl)
          Adds a progress listener to this generator.
 java.lang.String getDescription()
          Gets a descriptive string for this generator
 java.util.List<StatisticsRecorder> getStatRecorders()
          Gets a list of the statistic recorders operating in this generator
 void removeProgressListener(ProgressListener pl)
          Removes a progressListener from this generator
 void signalToStop()
          Signals that the generator should stop execution at the earliest opportunity
 
Methods inherited from interface java.lang.Runnable
run
 

Method Detail

signalToStop

void signalToStop()
Signals that the generator should stop execution at the earliest opportunity


addProgressListener

void addProgressListener(ProgressListener pl)
Adds a progress listener to this generator. The listener will be kept updated with the generator's progress

Parameters:
pl - The listener to add

removeProgressListener

void removeProgressListener(ProgressListener pl)
Removes a progressListener from this generator

Parameters:
pl - The listener to remove

getStatRecorders

java.util.List<StatisticsRecorder> getStatRecorders()
Gets a list of the statistic recorders operating in this generator

Returns:
A list of statistic recorders

getDescription

java.lang.String getDescription()
Gets a descriptive string for this generator

Returns:
A string describing this generator