Package hec.rss.model

Class RssTSLocationObject

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.rss.model.RssTSLocationObject
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, TSLocation, RssModelVariableConstants, RssReturnStatusConstants, RssTSLocation, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable
Direct Known Subclasses:
ForebayHeadLoss, Function, OpController, OpRule, OpSet, RssRatingObject, Rule, StateVariable, TailwaterElevation, WaterAccount, WaterControlDevice
public abstract class RssTSLocationObject extends NamedType implements RssTSLocation, RssReturnStatusConstants, RssModelVariableConstants
Title: HEC JavaDev Description: Copyright: Company: RMA
See Also:

  • Constructor Details

    • RssTSLocationObject

      public RssTSLocationObject()

    • RssTSLocationObject

      public RssTSLocationObject(String name)

  • Method Details

    • getSystem

      public abstract RssSystem getSystem()
      Each subclass must provide a method to return its parent RssSystem

    • getComputedTSRecordProxies

      public Vector getComputedTSRecordProxies(Vector v)
      returns a vector of computed ts record proxies assuming the downstream flow is computed

    • copyInto

      public void copyInto(RssTSLocationObject tsLocObj)

    • clone

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

    • clearTSProxyList

      public void clearTSProxyList()
      dumps all ts proxies

    • updateTSProxyList

      public abstract 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 sub-classes of Function should over-ride this method if they use TSRecordProxies

    • getTSRecordProxies

      public Vector getTSRecordProxies()

    • getTSRecordProxy

      public TSRecordProxy getTSRecordProxy(String param)
      Deprecated.
      replaced by getTSRecordProxy(int varid)

    • getTSRecordProxy

      public TSRecordProxy getTSRecordProxy(String param, boolean isinput)
      Deprecated.
      replaced by getTSRecordProxy(int varid)

    • getTSRecordProxy

      public TSRecordProxy getTSRecordProxy(String name, String param, boolean isinput)
      Deprecated.
      replaced by getTSRecordProxy(String name, int varid)

    • getTSRecordProxy

      public TSRecordProxy getTSRecordProxy(int varId)
      finds a TSRecordProxy for the given variable id in this TSLocation
      Specified by:
      getTSRecordProxy in interface RssTSLocation

    • getTSRecordProxyVec

      public Vector getTSRecordProxyVec(int varId, Vector proxyVec)
      finds all TSRecordProxies for the given variable id in this TSLocation and adds them to the given vector

    • getTSRecordProxy

      public TSRecordProxy getTSRecordProxy(String name, int varId)
      finds a TSRecordProxy for the given variable id and name in this TSLocation

    • getActiveTSRecordProxies

      public Vector getActiveTSRecordProxies(Vector vec, int iotype)
      add the time series record proxies associated current compute. Will typically be overrided by subclasses

    • addTSRecordProxy

      public TSRecordProxy addTSRecordProxy(int varId)
      Adds a TSRecordProxy by model variable Id

    • addTSRecordProxy

      public TSRecordProxy addTSRecordProxy(String name, int varId)
      Adds a TSRecordProxy by model variable Id

    • addTSRecordProxy

      public TSRecordProxy addTSRecordProxy(String name, String param, int varId)
      Adds a TSRecordProxy by model variable Id, with specified name and parameter name

    • addTSRecord

      public TSRecordProxy addTSRecord(String name, String param, boolean isinput)
      Deprecated.
      adds a TSRecordProxy to this function by name, parameter, and input/output flag

    • removeTSRecordProxy

      public boolean removeTSRecordProxy(String name, int vid)
      remove all TSRecordProxies matching the variable id and name

    • removeTSRecordProxy

      public boolean removeTSRecordProxy(int vid)
      remove all TSRecordProxies matching the variable id

    • removeTSRecord

      public boolean removeTSRecord(String proxyName)
      Deprecated.
      remove a TSRecordProxy named proxyName note this assumes that the name makes the proxy unique, which is not necessarily so

    • getTSContainer

      public doubleArrayContainer getTSContainer(int vid)
      returns the double array containing the time series of the record according to variable id. returns null if unsuccessful

    • getTSContainer

      public doubleArrayContainer getTSContainer(String name, int vid)
      returns the double array containing the time series of the record according to variable id and name. returns null if unsuccessful

    • getTSArray

      public double[] getTSArray(int vid)
      returns the double array containing the time series of the record according to variable id. returns null if unsuccessful

    • getTSArray

      public double[] getTSArray(String name, int vid)
      returns the double array containing the time series of the record according to variable id and name. returns null if unsuccessful

    • getTSArray

      public double[] getTSArray(String param)
      Deprecated.

    • getTSArray

      public double[] getTSArray(String param, boolean isinput)
      Deprecated.

    • getTSDataSet

      public TSDataSet getTSDataSet(boolean isInput)
      returns the TSDataSet that holds TSRecords for current input and output
      Specified by:
      getTSDataSet in interface TSLocation

    • 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 NamedType
      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 NamedType
      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