edu.iu.iv.modeling.tarl.main
Interface TarlHelper

All Known Implementing Classes:

DefaultTarlHelper

public interface TarlHelper

This interface defines the functions for the TarlHelper which mainly assists the TarlMain in carrying out its functions. It takes care of the details of initializing the Tarl model, running it, freeing the resources and producing the desired output.

Author:

Jeegar T Maru

See Also:

TarlMainInterface

Method Summary

void	cleanUpSystem() Cleans up the system.
void	initializeModel(HelperParameters helperParameters, java.io.File agingFunctionFile) Initializes the Tarl model.
void	runModel() Runs the Tarl model.
void	writeOutputFiles(java.lang.String outputFolderName) Stores the output of the model on the file system.

Method Detail

initializeModel

public void initializeModel(HelperParameters helperParameters,
                            java.io.File agingFunctionFile)
                     throws TarlException

Initializes the Tarl model. This function accepts the HelperParameters to be used for initialization as well as when running the model. Upon execution, the Tarl model should be initialized to be run in the future.

Parameters:

helperParameters - Specifies the input parameters for the model to be used for initialization as well as when the model is run

Throws:

TarlException - if the model constraints are violated

runModel

public void runModel()
              throws TarlException

Runs the Tarl model. This function should be called only after initialization.

Throws:

TarlException - if the model constraints are violated

writeOutputFiles

public void writeOutputFiles(java.lang.String outputFolderName)

Stores the output of the model on the file system. The output files should contain information about the results that the model produced.

Parameters:

outputFolderName - Specifies the name of the output folder

cleanUpSystem

public void cleanUpSystem()

Cleans up the system. This function frees the resources that the Tarl system used while running the model. After calling this function, the Tarl model loses all its data and hence is not able to produce any output. Thus, output data must be gathered before cleaning up the system.