Options
All
  • Public
  • Public/Protected
  • All
Menu

A class that holds information about the files and settings that will be inputs to W.I.S.E..

author

"Travis Redpath"

Hierarchy

  • WISEInputs

Index

Constructors

constructor

Properties

assetFiles

assetFiles: AssetFile[] = new Array<AssetFile>()

Assets that can stop simulations when reached.

files

Information about the files that may be needed by the scenarios.

fuelOptions

fuelOptions: FuelOption[] = new Array<FuelOption>()

Options to apply to the fuel types in the LUT file.

ignitions

ignitions: Ignition[] = new Array<Ignition>()

All ignition features.

scenarios

scenarios: Scenario[] = new Array<Scenario>()

The scenarios to run. At least one is required.

targetFiles

targetFiles: TargetFile[] = new Array<TargetFile>()

Targets that can affect how weather information is processed.

timezone

timezone: Timezone

The timezone of the scenarios (required).

weatherStations

weatherStations: WeatherStation[] = new Array<WeatherStation>()

All weather stations. At least one is required.

Methods

checkValid

  • Find any errors in the W.I.S.E. input values.

    Returns Array<ValidationError>

    A list of errors that were found.

isValid

  • isValid(): boolean
  • Validate the user specified inputs.

    Returns boolean

    A list of errors found during validation.

stream

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

    Parameters

    • builder: Socket

    Returns void