uaa.feral.physical.behaviors
Interface HydroBehavior

All Known Implementing Classes:
EvolveHydrology, GroundWaterModelWrapper, RemoteSensingEstimator, StaticDischargeModel, VolumeEstimatorModel

public interface HydroBehavior

Interface for running different hydrological behaviors

Author:
Mark Altaweel

Method Summary
 java.lang.String getName()
          Method to get the name of the model
 java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,double[]>> getWaterBodyData()
          Method gets data for a water body based on the water body's name, with data containing info on monthly discharge/volume
 java.util.Map<java.lang.String,java.lang.Double> getWaterQuantityByBody()
          Method to get the current estimated discharge for rivers
 boolean isDegradeQuantity()
          Check to see if hydrology quantity is degraded
 void runModel()
          Method to run the model
 void setData(java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,double[]>> data)
          Discharge/volume data set according to river/water source name and data arranged by month (month represented by an integer
 void setDischargeInfo(java.lang.String river, int time, java.util.Map<java.lang.Integer,double[]> sample)
          Setter for monthly discharge data
 void setScenarioData(ScenarioData scenarioData)
          Method to set the scenario data
 void setTickReset(double tickReset)
          Method to reset when a model should reset to older data.
 

Method Detail

runModel

void runModel()
Method to run the model


getWaterQuantityByBody

java.util.Map<java.lang.String,java.lang.Double> getWaterQuantityByBody()
Method to get the current estimated discharge for rivers

Returns:

getWaterBodyData

java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,double[]>> getWaterBodyData()
Method gets data for a water body based on the water body's name, with data containing info on monthly discharge/volume

Returns:
a map with the water body's data

setDischargeInfo

void setDischargeInfo(java.lang.String river,
                      int time,
                      java.util.Map<java.lang.Integer,double[]> sample)
Setter for monthly discharge data

Parameters:
name - of the river this is relevant for
time - the time data is saved for (e.g. month, day, etc.)
sample - the discharge data associated with the month

setData

void setData(java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,double[]>> data)
Discharge/volume data set according to river/water source name and data arranged by month (month represented by an integer

Parameters:
data - the data map containing discharge/volume information

setTickReset

void setTickReset(double tickReset)
Method to reset when a model should reset to older data. This is intended to be used in a Markov model

Parameters:
tickReset - tick when to reset

getName

java.lang.String getName()
Method to get the name of the model


isDegradeQuantity

boolean isDegradeQuantity()
Check to see if hydrology quantity is degraded

Returns:
a boolean to see if degrade quantity or not

setScenarioData

void setScenarioData(ScenarioData scenarioData)
Method to set the scenario data

Parameters:
scenarioData - the scenario data