Class ScenarioEventReport

java.lang.Object
ca.spatial.reportwriter.Report
ca.spatial.patchworks.ScenarioEventReport
All Implemented Interfaces:
EventLogger, Selectable<Report>, Comparable<Report>, Observer

public class ScenarioEventReport extends Report implements EventLogger, Observer
This report logs significant events in the life cycle of a Patchworks simulation run.
  • Field Details

  • Constructor Details

    • ScenarioEventReport

      public ScenarioEventReport(String filename, String title, Control control)
  • Method Details

    • doReport

      public ca.spatial.reportwriter.Report.DataCache doReport(String filename, PrintStream out, Map<String,​Object> param, ca.spatial.reportwriter.Report.DataCache cache)
      Description copied from class: Report
      The method used by the report writer to format the requested report. This method is implemented in every custom report. Application programs generally do not need to call this method, but instead use the report writer methods to obtain reports.
      Specified by:
      doReport in class Report
      Parameters:
      filename - The full name of the report to be printed, including the extension of the sub-report (if any).
      out - The output stream to print output on to.
      param - A HashMap containing parameters that modify the report (for example the scenario name).
    • getTypes

      public String[] getTypes()
      Description copied from class: Report
      An accessor function to retrieve the list of report types supported by this report. See the documentation for the TYPES variable for the list of sub-types.
      Specified by:
      getTypes in class Report
    • logEvent

      public void logEvent(String event, String detail)
      Description copied from interface: EventLogger
      Add an event to the logger
      Specified by:
      logEvent in interface EventLogger
    • getControl

      public Control getControl()
    • update

      public void update(Observable o, Object args)
      Specified by:
      update in interface Observer
    • addNote

      public void addNote(String note)
    • addNote

      public void addNote(String event, String note)