Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WISEOutputs

Information about which files should be output from the job.

author

"Travis Redpath"

Hierarchy

  • WISEOutputs

Index

Constructors

constructor

Properties

assetStatsFiles

assetStatsFiles: AssetStatsFile[] = new Array<AssetStatsFile>()

Output a stats file with information about a specific asset.

fuelGridFiles

fuelGridFiles: Output_FuelGridFile[] = new Array<Output_FuelGridFile>()

The fuel grid files that should be output (optional).

gridFiles

gridFiles: Output_GridFile[] = new Array<Output_GridFile>()

The grid files that should be output (optional).

statsFiles

statsFiles: StatsFile[] = new Array<StatsFile>()

Output a stats file with information from each scenario timestep.

streamAll

streamAll: boolean = false

The default stream status for all newly created output files. If true, newly created output files will be defaulted to streaming to any specified stream locations. If false, newly created output files will be defaulted to not stream. The user can override this setting on each output file.

summaryFiles

summaryFiles: SummaryFile[] = new Array<SummaryFile>()

The summary files that should be output (optional).

vectorFiles

vectorFiles: VectorFile[] = new Array<VectorFile>()

The vector files that should be output (optional).

Methods

checkValid

  • Find all errors that may exist in the W.I.S.E. outputs.

    Returns Array<ValidationError>

    A list of errors that were found.

isValid

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

    Returns boolean

newAssetStatsFile

  • Create a new Asset stats file and add it to the list of asset stats file outputs.

    Parameters

    • scen: Scenario

      The scenario to output the stats for.

    Returns AssetStatsFile

newFuelGridFile

newGridFile

  • Create a new grid file and add it to the list of grid file outputs.

    Parameters

    Returns Output_GridFile

newStatsFile

  • Create a new stats file and add it to the list of stats file outputs.

    Parameters

    • scen: Scenario

      The scenario to output the stats for.

    Returns StatsFile

newSummaryFile

  • Create a new summary file and add it to the list of summary file outputs.

    Parameters

    Returns SummaryFile

newVectorFile

  • Create a new vector file and add it to the list of vector file outputs.

    Parameters

    Returns VectorFile

removeOutputAssetStatsFile

  • Remove an asset stats file from the scenario.

    Parameters

    Returns boolean

removeOutputFuelGridFile

  • Removes the output fuel grid file from a scenario

    Parameters

    Returns boolean

removeOutputGridFile

  • Removes the output grid file from a scenario

    Parameters

    Returns boolean

removeOutputStatsFile

  • removeOutputStatsFile(stat: StatsFile): boolean
  • Remove a stats file from the scenario.

    Parameters

    Returns boolean

removeOutputSummaryFile

  • Removes the output summary file from a scenario

    Parameters

    Returns boolean

removeOutputVectorFile

  • removeOutputVectorFile(stat: VectorFile): boolean
  • Removes the output vector file from a scenario

    Parameters

    Returns boolean

stream

  • stream(builder: Socket): void
  • Streams the output settings to a socket.

    Parameters

    • builder: Socket

    Returns void