com.azalient.api.a.model
Interface IResults

public interface IResults

A handle to a set of results, frequently the current, or most recently created set of results.
A results set (or book) consists of one or more pages. Each page can have one or more tables. Frequently, a tool or plugin will create a results page, and save all its results, perhaps in multiple tables, to that page.
So, for example, there might be one page for reporting on buses, and another page for reporting on taxis.

Field Summary

static String	CHAPTER_PAGE_SEP A separator used in the name, to separate chapter and page
static String	ESC_CHAPTER_PAGE_SEP An escaped version of the page separator, so that the symbol is not interpreted as something else in Excel

Method Summary

void	addNewResultListener(NewResultListener nrl) Add a listener that will be notified when new results tables are added
void	fireResultAdded(ResultsTable table) Called when a new table is added
String	name() The name of the results set
IResultsPage	page(ResultsType type, UTime time) Return the results page corresponding to the given type and time.
File	resultsDirectory() The directory where external results files will be, or have been, saved
boolean	save() Save the page of results internally, with in the AZA file
void	saveAsXLS(boolean asCSV) Save the page of results
boolean	valid() True if simulation has begun, making this set of results valid
void	valid(boolean b) Set to true when this set of results is worth keeping

Field Detail

CHAPTER_PAGE_SEP

static final String CHAPTER_PAGE_SEP

A separator used in the name, to separate chapter and page

See Also:

Constant Field Values

ESC_CHAPTER_PAGE_SEP

static final String ESC_CHAPTER_PAGE_SEP

An escaped version of the page separator, so that the symbol is not interpreted as something else in Excel

See Also:

Constant Field Values

Method Detail

name

String name()

The name of the results set

page

IResultsPage page(ResultsType type,
                  UTime time)

Return the results page corresponding to the given type and time. A new page will be created if required.

Parameters:

type - The type of the results page

time - A time stamp appended to the page name.

Returns:

The results page, creating a new one on the fly, if required

addNewResultListener

void addNewResultListener(NewResultListener nrl)

Add a listener that will be notified when new results tables are added

fireResultAdded

void fireResultAdded(ResultsTable table)

Called when a new table is added

valid

boolean valid()

True if simulation has begun, making this set of results valid

valid

void valid(boolean b)

Set to true when this set of results is worth keeping

save

boolean save()

Save the page of results internally, with in the AZA file

saveAsXLS

void saveAsXLS(boolean asCSV)

Save the page of results

resultsDirectory

File resultsDirectory()

The directory where external results files will be, or have been, saved