public class Scenario extends Object implements IWISESerializable
Constructor and Description |
---|
Scenario() |
Modifier and Type | Method and Description |
---|---|
AssetReference |
addAssetFile(AssetFile file)
Add an asset file to the scenario.
|
BurningConditions |
addBurningCondition(String date,
String startTime,
String endTime,
double fwiGreater,
double wsGreater,
double rhLess,
double isiGreater)
Add a new burning condition.
|
FuelBreak |
addFuelBreakReference(FuelBreak brck)
Add a fuel break to the scenario.
|
LayerInfo |
addFuelPatchReference(FuelPatch wthr,
int index)
Add a fuel patch to the scenario.
|
LayerInfo |
addGridFileReference(GridFile wthr,
int index)
Add a grid file to the scenario.
|
IgnitionReference |
addIgnitionReference(Ignition ignition)
Add an ignition to the scenario.
|
LayerInfo |
addWeatherGridReference(WeatherGrid wthr,
int index)
Add a weather grid to the scenario.
|
LayerInfo |
addWeatherPatchReference(WeatherPatch wthr,
int index)
Add a weather patch to the scenario.
|
StationStream |
addWeatherStreamReference(WeatherStream stream)
Add a weather stream to the scenario.
|
StationStream |
addWeatherStreamReference(WeatherStream stream,
boolean primary)
Add a weather stream to the scenario.
|
List<ValidationError> |
checkValid()
Find all errors that may exist in the object.
|
String |
getName()
The name of the scenario.
|
void |
makeCopy(Scenario toCopy)
Make this scenario a copy of another.
|
void |
setId(String value)
Set the name of the scenario.
|
void |
setName(String value)
Set the name of the scenario.
|
TargetReference |
setVectorTargetFile(TargetFile file)
Add a target file to the scenario for vector direction.
|
void |
setVectorTargetFile(TargetReference file)
Add a target file to the scenario for vector direction.
|
TargetReference |
setWindTargetFile(TargetFile file)
Add a target file to the scenario for wind direction.
|
void |
setWindTargetFile(TargetReference file)
Add a target file to the scenario for wind direction.
|
public void setId(String value)
A
- WISEException
will be thrown if value is null or empty.public String getName()
public void setName(String value)
A
- WISEException
will be thrown if value is null or empty.public BurningConditions addBurningCondition(String date, String startTime, String endTime, double fwiGreater, double wsGreater, double rhLess, double isiGreater)
date
- The date that the condition is valid on. Must be formatted as 'YYYY-MM-DD'.startTime
- The starting hour. Must be between 0 and 23 inclusive.endTime
- The ending hour. Must be between 1 and 24 inclusive.fwiGreater
- The minimum FWI value that will allow burning.wsGreater
- The minimum wind speed that will allow burning.rhLess
- The maximum relative humidity that will allow burning (as a percent [0-100]).isiGreater
- The minimum ISI that will allow burning.public IgnitionReference addIgnitionReference(Ignition ignition)
ignition
- The ignition to add to the scenario.public StationStream addWeatherStreamReference(WeatherStream stream)
stream
- The weather stream to add to the scenario.public StationStream addWeatherStreamReference(WeatherStream stream, boolean primary)
stream
- The weather stream to add to the scenario.primary
- Is this the primary weather stream for the scenario.public FuelBreak addFuelBreakReference(FuelBreak brck)
brck
- The fuel break to add to the scenario.public LayerInfo addWeatherGridReference(WeatherGrid wthr, int index)
wthr
- The weather grid to add to the scenario.index
- The layers index in the scenario.public LayerInfo addGridFileReference(GridFile wthr, int index)
grid
- The grid file to add to the scenario.index
- The layers index in the scenario.public LayerInfo addFuelPatchReference(FuelPatch wthr, int index)
patch
- The fuel patch to add to the scenario.index
- The layers index in the scenario.public LayerInfo addWeatherPatchReference(WeatherPatch wthr, int index)
patch
- The weather patch to add to the scenario.index
- The layers index in the scenario.public AssetReference addAssetFile(AssetFile file)
WISE
object.file
- The asset file to add to the scenario.public TargetReference setWindTargetFile(TargetFile file)
WISE
object.file
- The target file to add to the scenario.public void setWindTargetFile(TargetReference file)
WISE
object.file
- The target file to add to the scenario.public TargetReference setVectorTargetFile(TargetFile file)
WISE
object.file
- The target file to add to the scenario.public void setVectorTargetFile(TargetReference file)
WISE
object.file
- The target file to add to the scenario.public void makeCopy(Scenario toCopy)
toCopy
- The scenario to copy.public List<ValidationError> checkValid()
IWISESerializable
checkValid
in interface IWISESerializable
Copyright © 2022. All rights reserved.