Package hec.rss.model

Interface OpControllable

All Known Implementing Classes:
OpControllableElement, OpControllableObject, OpController
public interface OpControllable
Interface for objects that can be controlled by OpController objects.

  • Method Details

    • clone

      Object clone()
      Creates a new object of the same class as this object

    • setController

      void setController(OpController oc)
      sets the parent controller

    • initializeCompute

      boolean initializeCompute(RunTimeWindow rtw)
      prepares for computation

    • initForPostProcessing

      boolean initForPostProcessing(RunTimeWindow rtw)
      prepares for post processing

    • getAdjustableParameter

      AdjustableParameter getAdjustableParameter()
      returns the adjustable parameter associated with the controllable object

    • setParameterValue

      double setParameterValue(double val, RunTimeStep rts)
      sets the adjustable parameter value, returns the value actually applied

    • getCurrentParameterValue

      double getCurrentParameterValue()
      gets the total current adjustable parameter value

    • getPreviousParameterValue

      double getPreviousParameterValue(RunTimeStep rts)

    • getReleaseElementId

      int getReleaseElementId()
      index of release element this contrable is associated with

    • setReleaseElementId

      void setReleaseElementId(int elementId)
      set index of release element this contrable is associated with

    • setReleaseElement

      void setReleaseElement(Element e)
      sets the associated release element and release element id

    • initOperationStep

      int initOperationStep(RunTimeStep rts, int iteration)
      initialization called before each operation step

    • recalcPhysicalLimitsInst

      void recalcPhysicalLimitsInst(RunTimeStep rts, double elev)

    • recalcPhysicalLimits

      void recalcPhysicalLimits(RunTimeStep rts, double[] xt, double[] et, int tcnt)

    • getInstFlowCap

      double getInstFlowCap(RunTimeStep rts, double elev, double[] cntrl, double[] unctrl)
      return the instantaneous flow capacity at the given time step and elevation

    • getFlowForPrevGateHeight

      double getFlowForPrevGateHeight(RunTimeStep rts, double resElev)
      returns the estimated flow if the gate openings from the previous time step are maintained

    • getIncrROCLimit

      double getIncrROCLimit(RunTimeStep rts, double[] relcap, double[] dt, double elev, List rulelist)

    • getDecrROCLimit

      double getDecrROCLimit(RunTimeStep rts, double[] relcap, double[] dt, double elev, List rulelist)