Package hec.rss.model

Class ForebayHeadLoss

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.rss.model.RssTSLocationObject
hec.rss.model.ForebayHeadLoss
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, TSLocation, AltInputReportInfc, RssModelVariableConstants, RssReturnStatusConstants, RssTSLocation, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable
public class ForebayHeadLoss extends RssTSLocationObject implements Serializable, AsciiSerializable, Cloneable, RssModelVariableConstants, AltInputReportInfc
See Also:

  • Field Details

  • Constructor Details

    • ForebayHeadLoss

      public ForebayHeadLoss()

    • ForebayHeadLoss

      public ForebayHeadLoss(Element e)

  • Method Details

    • setElement

      public void setElement(Element e)

    • clone

      public Object clone()
      clone method
      Overrides:
      clone in class RssTSLocationObject

    • initialize

      public void initialize()

    • initForPostProcessing

      public void initForPostProcessing()
      Prepares this run for post processing in the ResSim Simulation Module. This routing sets up all data model connectivity, but does not load time series arrays.

    • getHeadLoss

      public double getHeadLoss(RunTimeStep rts)
      get head loss for current time step

    • getPrevHeadLoss

      public double getPrevHeadLoss(RunTimeStep rts)
      get head loss for previous time step

    • getHeadLoss

      public void getHeadLoss(RunTimeStep runtime, hec.data.ParamDouble pd)
      get head loss for current time step and store to given ParamDouble

    • getPrevHeadLoss

      public void getPrevHeadLoss(RunTimeStep runtime, hec.data.ParamDouble pd)
      get headloss for previous time step and store to given ParamDouble

    • getRatingObject

      public RssRatingObject getRatingObject()

    • getDefaultIndependentVariable

      public IndependentVariable getDefaultIndependentVariable()
      Default independent variable is two variable
      Returns:

    • getElement

      public Element getElement()

    • getSystem

      public RssSystem getSystem()
      Description copied from class: RssTSLocationObject
      Each subclass must provide a method to return its parent RssSystem
      Specified by:
      getSystem in class RssTSLocationObject

    • setRatingObject

      public void setRatingObject(RssRatingObject ro)

    • getReferencedStateVariables

      public void getReferencedStateVariables(List svlist)
      adds StateVariables refereced by this rule to the given list
      Parameters:
      svlist - unique list of state variables

    • getOutputBPart

      protected String getOutputBPart()

    • getActiveTSProxies

      public Vector getActiveTSProxies(Vector vec, int iotype)
      returns a vector of required input, or generated output TSRecordProxies used in the current alternative default implementation, assume all records are active

    • updateTSProxyList

      public void updateTSProxyList()
      Regenerates the list of all TSProxies required for this location. This list includes all records that are generated by this function even if the records are held in another objects (e.g. RssNode) proxy list
      Specified by:
      updateTSProxyList in class RssTSLocationObject

    • setupForSerialization

      public void setupForSerialization()
      Called just before ascii serialization. Prepares the paired data values by setting there dss record path names

    • getFieldObject

      public Object getFieldObject(Field fld)
      Description copied from interface: FieldAccessor
      This method allows access to java.lang.reflect.Field objects within the implementing class.
      Specified by:
      getFieldObject in interface FieldAccessor
      Overrides:
      getFieldObject in class RssTSLocationObject
      Parameters:
      fld - The field to get.
      Returns:
      The data object that is stored in the given field

    • setFieldObject

      public boolean setFieldObject(Field fld, Object fobj)
      Description copied from interface: FieldAccessor
      This allows access to fields withing the implementing object to set there data.
      Specified by:
      setFieldObject in interface FieldAccessor
      Overrides:
      setFieldObject in class RssTSLocationObject
      Parameters:
      fld - The java field object representing the member field to be set
      fobj - The data to set in that field
      Returns:
      returns true if successful

    • outputReport

      public void outputReport(AlternativeInputReport report, org.jdom.Element elem)
      Description copied from interface: AltInputReportInfc
      Alternative Input Report Interface for data.
      Specified by:
      outputReport in interface AltInputReportInfc