Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Output_FuelGridFile

Export a fuel grid.

Hierarchy

  • Output_FuelGridFile

Index

Properties

compression

compression: Output_GridFileCompression = Output_GridFileCompression.NONE

If the output file is a TIF file the contents will be compressed using this method.

filename

filename: string = ""

The name of the output file (required). The file will be located below the jobs output directory. All global paths and relative paths that attempt to move the file outside of this directory will be removed.

scenarioName

scenarioName: string = ""

The name of the scenario that this output is for (required).

shouldStream

shouldStream: boolean = false

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_GRIDFILE

PARAM_GRIDFILE: "fuel_grid_export" = "fuel_grid_export"

Methods

checkValid

isValid

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

    Returns boolean

stream

  • stream(builder: Socket): void
  • Streams the grid file to a socket.

    Parameters

    • builder: Socket

    Returns void