uaa.feral.social.waterUse
Class WaterUseBehaviors

java.lang.Object
  extended by uaa.feral.social.waterUse.WaterUseBehaviors
All Implemented Interfaces:
GeneralModel, WaterUseModel
Direct Known Subclasses:
MiningWaterUse, SocialDistancing, SocialDistancingModified

public abstract class WaterUseBehaviors
extends java.lang.Object
implements WaterUseModel

Class for use in water use behaviors

Author:
Mark Altaweel

Constructor Summary
WaterUseBehaviors()
           
 
Method Summary
static WaterUseModel CreateWaterUseModel(java.lang.String model, ScenarioData sd, Community community)
          Static method to create the desired model based on model's name.
 ScenarioData getScenarioData()
           
 boolean isDegradeQualityMode()
           
 boolean isLargeSimulation()
          Method to see if simulation is for large scenarios
 boolean isUpdatePreferences()
          Method to see if water source preferences should be updated during the simulation
 void runModel()
          Method to run the social water use model
 void setDegradeQualityMode(boolean degradeQualityMode)
          Set method for water quality degradation simulations
 void setLargeSimulation(boolean largeSimulation)
          Set method for large sims or not
 void setScenarioData(ScenarioData scenarioData)
           
 void setUpdatePreferences(boolean updatePreferences)
           
 void setupModelData(java.lang.String file)
          Method to setup model data used by a given water use model
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WaterUseBehaviors

public WaterUseBehaviors()
Method Detail

runModel

public void runModel()
Description copied from interface: GeneralModel
Method to run the social water use model

Specified by:
runModel in interface GeneralModel

CreateWaterUseModel

public static WaterUseModel CreateWaterUseModel(java.lang.String model,
                                                ScenarioData sd,
                                                Community community)
Static method to create the desired model based on model's name. Community object is then set to the model

Parameters:
model - a model to create
community - the community to associate the model to
Returns:
a WaterUseModel object

setupModelData

public void setupModelData(java.lang.String file)
Description copied from interface: GeneralModel
Method to setup model data used by a given water use model

Specified by:
setupModelData in interface GeneralModel
Parameters:
file - the file to use for model data

isUpdatePreferences

public boolean isUpdatePreferences()
Description copied from interface: WaterUseModel
Method to see if water source preferences should be updated during the simulation

Specified by:
isUpdatePreferences in interface WaterUseModel
Returns:
a boolean if there is update preferences

setUpdatePreferences

public void setUpdatePreferences(boolean updatePreferences)

isLargeSimulation

public boolean isLargeSimulation()
Description copied from interface: WaterUseModel
Method to see if simulation is for large scenarios

Specified by:
isLargeSimulation in interface WaterUseModel
Returns:
a boolean for large sims or not

setLargeSimulation

public void setLargeSimulation(boolean largeSimulation)
Description copied from interface: WaterUseModel
Set method for large sims or not

Specified by:
setLargeSimulation in interface WaterUseModel
Parameters:
largeSimulation - the boolean for large sims or not

isDegradeQualityMode

public boolean isDegradeQualityMode()

setDegradeQualityMode

public void setDegradeQualityMode(boolean degradeQualityMode)
Description copied from interface: WaterUseModel
Set method for water quality degradation simulations

Specified by:
setDegradeQualityMode in interface WaterUseModel
Parameters:
degradeQualityMode - the boolean for degradation simulations

getScenarioData

public ScenarioData getScenarioData()

setScenarioData

public void setScenarioData(ScenarioData scenarioData)
Specified by:
setScenarioData in interface GeneralModel