Package hec.rss.model

Class TailwaterElevation

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.rss.model.RssTSLocationObject
hec.rss.model.TailwaterElevation
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, TSLocation, AltInputReportInfc, RssModelVariableConstants, RssReturnStatusConstants, RssTSLocation, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable
public class TailwaterElevation extends RssTSLocationObject implements Serializable, AsciiSerializable, Cloneable, RssModelVariableConstants, AltInputReportInfc
Title: HEC JavaDev Description: Copyright: Company: RMA
See Also:

  • Constructor Details

    • TailwaterElevation

      public TailwaterElevation()
      Constructor for the TailwaterElevation object

    • TailwaterElevation

      public TailwaterElevation(Element e)

  • Method Details

    • getElementDependencies

      public void getElementDependencies(List<Element> elemList, Element parentElem)
      adds elements upon which the tailwater elevation depends to evaluate the storage zone value to the given list. Does not add the element that owns the tailwater elevation object.

    • getOutputBPart

      protected String getOutputBPart()

    • setupForSerialization

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

    • clone

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

    • initialize

      public void initialize()

    • computeElevation

      public void computeElevation(RunTimeStep runtime)

    • setElement

      public void setElement(Element e)

    • getElement

      public Element getElement()

    • usesConstElev

      public boolean usesConstElev()

    • setUsesConstElev

      public void setUsesConstElev(boolean b)

    • getConstElev

      public void getConstElev(hec.data.ParamDouble pd)

    • getElevation

      public double getElevation(RunTimeStep runtime)

    • getElevation

      public void getElevation(RunTimeStep runtime, hec.data.ParamDouble pd)
      get controlling tailwater elevation for current time step

    • isDefined

      public boolean isDefined(RunTimeStep runtime)
      Determine if tailwater flow is defined for current runtime Tailwater cannot be computed correctly unless flow is defined for requested time step
      Parameters:
      runtime -
      Returns:

    • setConstElev

      public void setConstElev(hec.data.ParamDouble pd)

    • usesDnstrmElev

      public boolean usesDnstrmElev()

    • setUsesDnstrmElev

      public void setUsesDnstrmElev(boolean b)

    • setDnstrmJuncId

      public void setDnstrmJuncId(int id)

    • getDnstrmJuncId

      public int getDnstrmJuncId()

    • usesRatingCurveElev

      public boolean usesRatingCurveElev()

    • setUsesRatingCurveElev

      public void setUsesRatingCurveElev(boolean b)

    • getRatingCurve

      public PairedValues getRatingCurve()
      returns a clone of the junctions rating curve

    • setRatingCurve

      public void setRatingCurve(PairedValues rc)
      replaces the junctions existing rating curve with the given PairedValues object, also adds/removes a stage time series record proxy as required

    • getStageDatum

      public void getStageDatum(hec.data.ParamDouble pd)

    • setStageDatum

      public void setStageDatum(hec.data.ParamDouble pd)

    • getRatingObject

      public RssRatingObject getRatingObject()

    • setRatingObject

      public void setRatingObject(RssRatingObject ro)

    • getDownstreamModelVariableElementId

      public int getDownstreamModelVariableElementId()

    • getDefaultIndependentVariable

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

    • getActiveTSRecordProxies

      public Vector getActiveTSRecordProxies(Vector vec, int iotype)
      add the time series record proxies associated current compute
      Overrides:
      getActiveTSRecordProxies in class RssTSLocationObject

    • 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

    • getReferencedStateVariables

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

    • 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

    • 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