Package modelarium.results.readonly

Class ReadOnlyResults

java.lang.Object
modelarium.results.readonly.ReadOnlyResults
public final class ReadOnlyResults extends Object
Class for providing a read-only view of the results of a model run.

This class wraps the mutable results the model built up during its run so that the run's agent-level and environment-level logs can be inspected without being modifiable.

  • Method Details

    • agents

      public ReadOnlyResultsForAgents agents()
      Returns the agent-level results of the model run.
      Returns:
      the run's ReadOnlyResultsForAgents instance

    • environment

      public ReadOnlyResultsForEnvironment environment()
      Returns the environment-level results of the model run.
      Returns:
      the run's ReadOnlyResultsForEnvironment instance

    • export

      public Path export(String exportDir)
      Exports the results of the model to a given export directory
      Parameters:
      exportDir - the directory to export the results to
      Returns:
      the Path directory containing the exported results

    • export

      public Path export(Path exportPath)
      Exports the results of the model to a given export directory given as a Path
      Parameters:
      exportPath - the path directory to export the results to
      Returns:
      the Path directory containing the exported results