Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SummaryFile

Output a summary for the specified scenario.

author

"Travis Redpath"

Hierarchy

  • SummaryFile

Index

Constructors

constructor

  • Create a new summary file.

    Parameters

    • scen: Scenario

      The name of the scenario to output a summary for.

    Returns SummaryFile

Properties

filename

filename: string

The name of the output file.

outputs

Which summary values should be output upon completion of the scenario.

Protected scenName

scenName: string

shouldStream

shouldStream: boolean

Should the file be streamed/uploaded to an external service after it has been created? The streaming services are defined by OutputStreamInfo and helper methods such as {@link WISE#streamOutputToMqtt} or {@link WISE#streamOutputToGeoServer}.

Static Private Readonly PARAM_SUMMARYFILE

PARAM_SUMMARYFILE: "summaryfile" = "summaryfile"

Methods

checkValid

  • Find all errors that may exist in the summary file output.

    Returns Array<ValidationError>

    A list of all errors that were found.

isValid

  • isValid(): boolean
  • Determine if all of the required values have been set.

    Returns boolean

stream

  • stream(builder: Socket): void
  • Streams the summary options to a socket.

    Parameters

    • builder: Socket

    Returns void