public class WeatherStation extends Object implements IWISESerializable
Constructor and Description |
---|
WeatherStation() |
Modifier and Type | Method and Description |
---|---|
WeatherStream |
addWeatherStream(String filename,
double hffmcValue,
int hffmcHour,
HFFMCMethod hffmcMethod,
double startingFfmc,
double startingDmc,
double startingDc,
double startingPrecip,
String startTime,
String endTime,
double talpha,
double tbeta,
double tgamma,
double wsalpha,
double wsbeta,
double wsgamma,
String comments)
Add a weather stream to the station.
|
WeatherStream |
addWeatherStream(String filename,
double hffmcValue,
int hffmcHour,
HFFMCMethod hffmcMethod,
double startingFfmc,
double startingDmc,
double startingDc,
double startingPrecip,
String startTime,
String endTime,
String comments)
Add a weather stream to the station.
|
List<ValidationError> |
checkValid()
Find all errors that may exist in the object.
|
String |
getName()
The name of the weather station.
|
void |
setId(String value)
Set the name of the weather station.
|
void |
setName(String value)
Set the name of the weather station.
|
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 List<ValidationError> checkValid()
IWISESerializable
checkValid
in interface IWISESerializable
public WeatherStream addWeatherStream(String filename, double hffmcValue, int hffmcHour, HFFMCMethod hffmcMethod, double startingFfmc, double startingDmc, double startingDc, double startingPrecip, String startTime, String endTime, String comments)
filename
- The file location for the streams data. Can either be the actual file path
or the attachment URL returned from WISE#addAttachment
hffmc_value
- The HFFMC value.hffmc_hour
- The hour the HFFMC value was measured. Must be between -1 and 23 inclusive.hffmc_method
- The method to calculate HFFMC.starting_ffmc
- The starting FFMC value.starting_dmc
- The starting DMC value.starting_dc
- The starting DC value.starting_precip
- The starting amount of precipitation.start_time
- The starting time of the weather stream. If a string is used it must be formatted as "YYYY-MM-DD".end_time
- The ending time of the weather stream. If a string is used it must be formatted as "YYYY-MM-DD".comments
- An optional user comment to attach to the weather stream.If
- SocketMsg.inlineThrowOnError
is set and SocketMsg.skipFileTests
is not set a ca.firegrowthmodel.api.WISEException
will be thrown if the file doesn't exist.public WeatherStream addWeatherStream(String filename, double hffmcValue, int hffmcHour, HFFMCMethod hffmcMethod, double startingFfmc, double startingDmc, double startingDc, double startingPrecip, String startTime, String endTime, double talpha, double tbeta, double tgamma, double wsalpha, double wsbeta, double wsgamma, String comments)
filename
- The file location for the streams data. Can either be the actual file path
or the attachment URL returned from WISE#addAttachment
hffmc_value
- The HFFMC value.hffmc_hour
- The hour the HFFMC value was measured. Must be between -1 and 23 inclusive.hffmc_method
- The method to calculate HFFMC.starting_ffmc
- The starting FFMC value.starting_dmc
- The starting DMC value.starting_dc
- The starting DC value.starting_precip
- The starting amount of precipitation.start_time
- The starting time of the weather stream. If a string is used it must be formatted as "YYYY-MM-DD".end_time
- The ending time of the weather stream. If a string is used it must be formatted as "YYYY-MM-DD".talpha
- The diurnal alpha temperature parameter.tbeta
- The diurnal alpha temperature parameter.tgamma
- The diurnal gamma temperature parameter.wsalpha
- The diurnal alpha wind speed parameter.wsbeta
- The diurnal beta wind speed parameter.wsgamma
- The diurnal gamma wind speed parameter.comments
- An optional user comment to attach to the weather stream.If
- SocketMsg.inlineThrowOnError
is set and SocketMsg.skipFileTests
is not set a ca.firegrowthmodel.api.WISEException
will be thrown if the file doesn't exist.Copyright © 2022. All rights reserved.