Parameters and Constructors

Figure 124. Range Indicator Compare Report Constructor


public CompareReport(String filename,           1
                     String title,              2
                     ReportWriter ReportWriter, 3
                     ComparisonWriter cw,       4
                     String units,              5
                     String xCaption,           6
                     String bwCaption,          7
                     String[] paths,            8
                     String[] columns,          9
                     String[] classNames,       10
                     double[][][][] threshData  11,
                     String[] html      )       12

	  


1

filename - The basename to be used for output from this Comparison Report. This name must be unique compared to all other reports and must contain NO file extension as three files will be automatically created with this filename (.html, .png, .csv).

2

title - The title to be displayed in the HTML and PNG sub-reports, as well as the name to appear in the Comparison Writer directory tree.

3

ReportWriter - By specifying 'ReportWriter' the Comparison Writer will look to the Report writer to get the CURRENT scenario that is running at the moment. Without specifying 'ReportWriter' the current scenario will not be included in the report, only those reports in saved scenario folders.

4

A reference to the container ReportWriter.

5

Units to be displayed on the y axis

6

The caption on the x axis.

7

The legend caption.

8

The list of reports within the scenarios to compare.

9

The columns within the reports to compare.

10

The names to be placed on the xaxis for each category.

11

The upper and lower limit data, organized first by category.

12

Additional HTML text to be displayed in the report.