Package hec.rss.model

Interface StateVariableJavaInfc

public interface StateVariableJavaInfc
The Interface StateVariableJavaInfc is used to create Java based State Variables. Author: Shannon Larson of RMA

  • Method Details

    • initialization

      boolean initialization(StateVariable currentSV, RssSystem rssSys)
      Initializes the state variable. Replaces the Jython State Variable's "Initialization" script.
      Parameters:
      currentSV - the current state variable
      rssSys - the Network
      Returns:
      true, if successful

    • main

      void main(StateVariable currentSV, RunTimeStep currentRunTimeStep, RssSystem rssSys)
      Evaluate's the State Variable at each time step. Replaces the Jython State Variable's "Main" script.
      Parameters:
      currentSV - the current state varaible
      currentRunTimeStep - the current run time step
      rssSys - the Network

    • cleanUp

      boolean cleanUp(StateVariable currentSV, RssSystem rssSys)
      Clean up the state variable. R eplaces the Jython State Variable's "CleanUp" script.
      Parameters:
      currentSV - the current state variable
      rssSys - the Network
      Returns:
      true, if successful