Package hec.rss.model

Class RssAlt

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.clientapp.model.Manager
hec.rss.model.RssAlt
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, LockableObject, MessagePrinter, TsRecordContainer, AltInputReportInfc, Serializable, Cloneable, Comparable, Observer, mil.army.usace.hec.rmi.csinterface.CallBackInterface, rma.lang.Modifiable
public class RssAlt extends Manager implements Cloneable, AltInputReportInfc
The Class RssAlt.
See Also:

  • Field Details

    • FILE_EXT

      public static final String FILE_EXT
      The Constant FILE_EXT.
      See Also:

    • TS_DATASET_FILE_EXT

      public static final String TS_DATASET_FILE_EXT
      file extension for TSDataSet files
      See Also:

    • OBS_SUFFIX

      public static final String OBS_SUFFIX
      suffix for Variant Obs TSDataSet name
      See Also:

    • REPORT_EXT

      public static final String REPORT_EXT
      The Constant REPORT_EXT.
      See Also:

    • PER_AVG_TIME

      public static final int PER_AVG_TIME
      The Constant PER_AVG_TIME.
      See Also:

    • VERSION

      public static final int VERSION
      1001 moved compute holdout, unreg and log level from run to alt.
      See Also:

    • INFLOW_FACTOR_GLOBAL

      public static final int INFLOW_FACTOR_GLOBAL
      types for the inflow factor.
      See Also:

    • INFLOW_FACTOR_LOCATION

      public static final int INFLOW_FACTOR_LOCATION
      The Constant INFLOW_FACTOR_LOCATION.
      See Also:

    • FLOW_COMPUTE_DEFAULT

      public static final int FLOW_COMPUTE_DEFAULT
      The Constant FLOW_COMPUTE_DEFAULT.
      See Also:

    • FLOW_COMPUTE_PERAVG

      public static final int FLOW_COMPUTE_PERAVG
      The Constant FLOW_COMPUTE_PERAVG.
      See Also:

    • FLOW_COMPUTE_INSTANT

      public static final int FLOW_COMPUTE_INSTANT
      The Constant FLOW_COMPUTE_INSTANT.
      See Also:

    • _timeStep

      protected int _timeStep
      time step. number of minutes, hours, or days

    • _timeIncrement

      protected int _timeIncrement
      time increment. one of HecTime.MINUTE_INCREMENT, HecTime.HOUR_INCREMENT or HecTime.DAY_INCREMENT

    • _flowComputeType

      protected int _flowComputeType
      The _flow compute type.

  • Constructor Details

    • RssAlt

      public RssAlt(String name)
      The Alternative must be constructed with a name. The name should be unique among Alternative objects within a model Workspace.
      Parameters:
      name - a short, unique name to identify the Run

    • RssAlt

      public RssAlt()
      Instantiates a new rss alt.

  • Method Details

    • useObsTSData

      public boolean useObsTSData()
      Check the flag that indicates whether observed TS data will be used in the compute (to set junction flows)
      Returns:
      true is observed TS data is used

    • getOutputVerticalDatumType

      public OutputVerticalDatumType getOutputVerticalDatumType()

    • setOutputVerticalDatumType

      public void setOutputVerticalDatumType(OutputVerticalDatumType outputVerticalDatumType)

    • setUseObsTSData

      public void setUseObsTSData(boolean b)
      Set the flag that indicates whether observed TS data will be used in the compute (to set junction flows)

    • setEmbeddedAltRefList

      public void setEmbeddedAltRefList(List<ModelReference> embeddedAltRefList)
      Sets the embedded alt ref list.
      Parameters:
      embeddedAltRefList - the new embedded alt ref list

    • getEmbeddedAltRefList

      public List<ModelReference> getEmbeddedAltRefList()
      Gets the embedded alt ref list.
      Returns:
      the embedded alt ref list

    • indexOfEmbeddedAltRefList

      public int indexOfEmbeddedAltRefList(ModelReference altRef)
      Index of embedded alt ref list.
      Parameters:
      altRef - the alt ref
      Returns:
      the int

    • containsEmbeddedAltRefList

      public boolean containsEmbeddedAltRefList(ModelReference altRef)
      Contains embedded alt ref list.
      Parameters:
      altRef - the alt ref
      Returns:
      true, if successful

    • addEmbeddedAltRef

      public void addEmbeddedAltRef(ModelReference altRef)
      Adds the embedded alt ref.
      Parameters:
      altRef - the alt ref

    • removeEmbeddedAltRef

      public void removeEmbeddedAltRef(ModelReference altRef)
      Removes the embedded alt ref.
      Parameters:
      altRef - the alt ref

    • getYieldAnalysisWaterSupplyRules

      public List<YieldAnalysisRuleRef> getYieldAnalysisWaterSupplyRules()
      Get the list of Water Supply rules that can be used as a basis for Yield Analysis. These include Downstream minimum flow rules, at site minimum flow rules, at site and diversion rules.
      Returns:
      ArrayList of water supply rules that can be used as a basis for yield analysis

    • getYieldAnalysisHydropowerRules

      public List<YieldAnalysisRuleRef> getYieldAnalysisHydropowerRules()
      Get the list of hydropower rules that can be used as a basis for Yield Analysis. These include hydropower and system hydropower rules.
      Returns:
      ArrayList of hydropower rules that can be used as a basis for yield analysis

    • modifiyForSaveAs

      public boolean modifiyForSaveAs()
      called during saveAs to allow managers to modify themselves as necessary, returns true if there are changes made.
      Overrides:
      modifiyForSaveAs in class Manager
      Returns:
      true, if successful

    • addResOpSetSelection

      public void addResOpSetSelection(int resId, int opsetId)
      adds an entry into the reservoir operation set selection table matching the reservoir index the the operation set index.
      Parameters:
      resId - the res id
      opsetId - the opset id

    • addDivOpSetSelection

      public void addDivOpSetSelection(int divId, int opsetId)
      adds an entry into the diverion operation set selection table matching the diversion index the the operation set index.
      Parameters:
      divId - the diversion id
      opsetId - the opset id

    • addResSysOpSetSelection

      public void addResSysOpSetSelection(long resId, int opsetId)
      adds an entry into the reservoir operation set selection table matching the reservoir index the the operation set index.
      Parameters:
      resId - the res id
      opsetId - the opset id

    • removeResSysOpSetSelection

      public void removeResSysOpSetSelection(long resId)
      removes an entry into the reservoir operation set selection table matching the reservoir index.
      Parameters:
      resId - the res id

    • setHindcastData

      public void setHindcastData(Vector data)
      Sets the hindcast data.
      Parameters:
      data - the new hindcast data

    • getHindcastData

      public Vector getHindcastData()
      Returns a Vector list of HindCast Data Objects.
      Returns:
      the hindcast data

    • clearAllResOpSetSelection

      public void clearAllResOpSetSelection()
      clears all entries in the reservoir operation set selection table.

    • clearAllDivOpSetSelection

      public void clearAllDivOpSetSelection()
      clears all entries in the reservoir operation set selection table.

    • clearAllResSysOpSetSelection

      public void clearAllResSysOpSetSelection()
      clears all entries in the reservoir operation set selection table.

    • getResOpSetSelection

      public int getResOpSetSelection(int resId)
      retrieves the operation set selection for the given reservoir index - returns RMAConst.UNDEF_INT if the reservoir has no operation set selection.
      Parameters:
      resId - the res id
      Returns:
      the res op set selection

    • getDivOpSetSelection

      public int getDivOpSetSelection(int divId)
      retrieves the operation set selection for the given diversion index - returns RMAConst.UNDEF_INT if the diversion has no operation set selection.
      Returns:
      the diversion op set selection

    • getResSysOpSetSelection

      public int getResSysOpSetSelection(int resSysId)
      Gets the res sys op set selection.
      Parameters:
      resSysId - the res sys id
      Returns:
      the res sys op set selection

    • init

      public void init()
      Specified by:
      init in class Manager

    • getSystem

      public RssSystem getSystem()
      gets the RssSystem used by this alternative.
      Returns:
      the system

    • loadNetworkByID

      protected boolean loadNetworkByID()
      Load network by id.
      Returns:
      true, if successful

    • loadNetworkByPath

      protected boolean loadNetworkByPath()
      Load network by path.
      Returns:
      true, if successful

    • getInputGVDataSet

      public GVDataSet getInputGVDataSet(TsVariant variant)
      Parameters:
      variant -
      Returns:

    • getInputGVDataSet

      public GVDataSet getInputGVDataSet()
      gets the default Input Globacl Variable DataSet used by this alternative.
      Returns:
      the default input global variable data set

    • getGVDataSetPath

      public String getGVDataSetPath()
      Gets the data set path.
      Returns:
      the data set path

    • getWQDataSetPath

      public String getWQDataSetPath()
      Gets the data set path for water quality input time series.
      Returns:
      the data set path

    • getInputGVDataPath

      public String getInputGVDataPath()
      Gets the input global variable data path.
      Returns:
      the input global variable data path

    • setGVDataSetPath

      public void setGVDataSetPath(String path)
      Sets the global variable input data set path.
      Parameters:
      path - the new data set path

    • getInputGVDataSet

      public GVDataSet getInputGVDataSet(String variant, boolean hasNonDefaultInput)
      get the input TSDataSet for a particular variant
      Parameters:
      variant - the variant name or null for the default TSDataSet
      Returns:

    • getInputTSDataSet

      public TSDataSet getInputTSDataSet(TsVariant variant)
      Parameters:
      variant -
      Returns:
      input time series data set

    • getInputTSDataSet

      public TSDataSet getInputTSDataSet(String variant, boolean hasNonDefaultInput)
      get the input TSDataSet for a particular variant
      Parameters:
      variant - the variant name or null for the default TSDataSet
      Returns:

    • getInputTSDataSet

      public TSDataSet getInputTSDataSet()
      gets the default Input TSDataSet used by this alternative.
      Overrides:
      getInputTSDataSet in class Manager
      Returns:
      the default input ts data set

    • getInputWQTSDataSet

      public TSDataSet getInputWQTSDataSet()
      Gets the default Input TSDataSet used for water quality input by this alternative.
      Returns:
      the default input tsDataSet for water quality

    • getInputWQPDCDataSet

      public PDCDataSet getInputWQPDCDataSet(TsVariant variant)

    • getInputWQPDCDataSet

      public PDCDataSet getInputWQPDCDataSet()

    • getInputWQPDCDataSet

      public PDCDataSet getInputWQPDCDataSet(@CheckForNull RunTimeWindow rtw)

    • getInputWQTSDataSet

      public TSDataSet getInputWQTSDataSet(TsVariant variant)
      Retrieves the TSdata set for the water quality input data
      Parameters:
      variant -
      Returns:

    • getInputWQTSDataPath

      public String getInputWQTSDataPath()
      Gets the input water quality data path.
      Returns:
      the input globa variable data path

    • setWQDataSetPath

      public void setWQDataSetPath(String path)
      Sets the water qulaity input data set path.
      Parameters:
      path - the new data set path

    • getInputWQTSDataSet

      public TSDataSet getInputWQTSDataSet(String variant, boolean hasNonDefaultInput)
      get the input TSDataSet for water qulaity input for a particular variant Not implememnted yet. Waitng for use with Model Linking
      Parameters:
      variant - the variant name or null for the default TSDataSet
      Returns:
      the ts data set for water qualtiy for the variant

    • getInputWQPDCDataSet

      public PDCDataSet getInputWQPDCDataSet(String variant, boolean hasNonDefaultInput)
      get the input PDCDataSet for water quality input for a particular variant Not implemented yet. Waiting for use with Model Linking
      Parameters:
      variant - the variant name or null for the default TSDataSet
      Returns:
      the ts data set for water quality for the variant

    • getObsWQPDCDataSet

      public PDCDataSet getObsWQPDCDataSet(TsVariant variant)
      Retrieves the PDCData set for the water quality observed data
      Parameters:
      variant -
      Returns:

    • getObsWQPDCDataSet

      public PDCDataSet getObsWQPDCDataSet(TsVariant variant, RunTimeWindow rtw)
      Retrieves the PDCData set for the water quality observed data
      Parameters:
      variant -
      Returns:

    • getObsWQPDCDataSet

      public PDCDataSet getObsWQPDCDataSet(String variant, boolean hasNonDefaultInput)

    • getObsWQPDCDataSet

      public PDCDataSet getObsWQPDCDataSet(String variant, boolean hasNonDefaultInput, RunTimeWindow rtw)

    • getOutputTSDataSet

      public TSDataSet getOutputTSDataSet()
      gets the Output TSDataSet used by this alternative.
      Overrides:
      getOutputTSDataSet in class Manager
      Returns:
      the output ts data set

    • getSystemName

      public String getSystemName()
      Gets the system name.
      Returns:
      the system name

    • getOperationsName

      public String getOperationsName()
      Gets the operations name.
      Returns:
      the operations name

    • getObservedTSDataName

      public String getObservedTSDataName()
      Gets the observed ts data name.
      Returns:
      the observed ts data name

    • getObservedTSDataPath

      public String getObservedTSDataPath()
      Gets the observed ts data path.
      Returns:
      the observed ts data path

    • getObservedTSDataSet

      public TSDataSet getObservedTSDataSet()
      Gets the observed ts data set.
      Returns:
      the observed ts data set

    • getObservedTSDataSet

      public TSDataSet getObservedTSDataSet(TsVariant variant)
      get the Observed TSDataSet for the specified TsVariant
      Parameters:
      variant -
      Returns:

    • getObsTSVariantNames

      public List<String> getObsTSVariantNames()
      get the list of Observed TS Variant names
      Returns:

    • getObservedTSDataSet

      public TSDataSet getObservedTSDataSet(String variant, boolean hasNonDefaultInput)
      get the observed TSDataSet for a particular variant
      Parameters:
      variant - the variant name or null for the default observed TSDataSet
      Returns:

    • getInputTSDataName

      public String getInputTSDataName()
      Gets the input ts data name.
      Returns:
      the input ts data name

    • getInputTSDataPath

      public String getInputTSDataPath()
      Gets the input ts data path.
      Returns:
      the input ts data path

    • getInputTSDataPath

      public String getInputTSDataPath(String variant)

    • getOutputTSDataName

      public String getOutputTSDataName()
      Gets the output ts data name.
      Returns:
      the output ts data name

    • getWriteDSSOutputDataTable

      public DssOutputData getWriteDSSOutputDataTable()
      Gets the write dss output data table.
      Returns:
      the write dss output data table

    • getGlobalVariablesTable

      public AltGlobalVarData getGlobalVariablesTable()
      Returns:

    • setWriteDSSOutputDataTable

      public void setWriteDSSOutputDataTable(DssOutputData table)
      Sets the write dss output data table.
      Parameters:
      table - the new write dss output data table

    • setSystemPath

      @Deprecated public void setSystemPath(String path)
      Deprecated.
      - use setSystemIndex()
      Sets the system path.
      Parameters:
      path - the new system path

    • setSystemIndex

      public void setSystemIndex(int networkID)
      Sets the system index.
      Parameters:
      networkID - the new system index

    • getSystemPath

      @Deprecated public String getSystemPath()
      Deprecated.
      - use getSystemIndex()
      Gets the system path.
      Returns:
      the system path

    • getSystemIndex

      public int getSystemIndex()
      Gets the system index.
      Returns:
      the system index

    • setOperationsPath

      public void setOperationsPath(String path)
      Sets the operations path.
      Parameters:
      path - the new operations path

    • getOperationsPath

      public String getOperationsPath()
      Gets the operations path.
      Returns:
      the operations path

    • setFlowComputeType

      public void setFlowComputeType(int type)
      Sets the flow compute type.
      Parameters:
      type - the new flow compute type

    • setPerAvgFlow

      public void setPerAvgFlow(boolean b)
      set true if period average flow calcs.
      Parameters:
      b - the new per avg flow

    • setDataSetPath

      public void setDataSetPath(String path)
      Sets the data set path.
      Parameters:
      path - the new data set path

    • setObservedDataSetPath

      public void setObservedDataSetPath(String path)
      Sets the observed data set path.
      Parameters:
      path - the new observed data set path

    • getDataSetPath

      public String getDataSetPath()
      Gets the input time series data set path.
      Returns:
      the data set path

    • writeFile

      public boolean writeFile(Identifier id)
      writeData saves the Run data to the specified ASCII file. If no path name is given, the method uses the current pathname of the Run.

      The file is written using type=param formatting. See the readData method for definition of types and parameters.

      Overrides:
      writeFile in class Manager
      Parameters:
      id - the id
      Returns:
      true, if successful

    • reLoadFile

      public boolean reLoadFile(Identifier id)
      readData retrieves the Run data from the specified ASCII file. If no path name is given, the method uses the current pathname of the Run.

      The file must have type=param formatting. The following types and parameters are defined.

      Run Name= (String) name of the Run
      Run Description= (String) description of the Run
      System Path= (String) relative path name of the System file
      Operations Path= (String) relative path name of the Operations file
      InputTSData Path= (String) relative path name of the input TSDataSet file
      OutputTSData Path= (String) relative path name of the output TSDataSet file
      Start Time= (String) start of forecast date/time string in any standard HEC format
      End Time= (String) end of forecase date/time string in any standard HEC format
      Lookback= (int) lookback period in days
      Time Step= (double) computation time step in hours

      Overrides:
      reLoadFile in class Manager
      Parameters:
      id - the id
      Returns:
      true, if successful

    • readFile

      public boolean readFile(Identifier id)
      Overrides:
      readFile in class Manager

    • isValid

      public boolean isValid()
      Checks the whether the Run ready to perform a compute. This function is not fully implemented yet!
      Overrides:
      isValid in class NamedType
      Returns:
      true is returned if a compute may be performed.

    • setTimeStep

      public void setTimeStep(int timeStep, int increment)
      Sets the time step and increment type it is. The increment is defined as HOURS, MINUTES, DAYS, as defined by HecTime
      Parameters:
      timeStep - the time step
      increment - the increment
      See Also:

    • getTimestep

      public int getTimestep()
      Gets the timestep.
      Returns:
      the timestep

    • getTimestepIncrement

      public int getTimestepIncrement()
      Gets the timestep increment.
      Returns:
      the timestep increment

    • getAltPluginData

      public hec.rss.plugins.model.AltPluginData getAltPluginData(String type)
      Gets the instance of AltPluginData for the given Type model.
      Parameters:
      type - String. Typically use choices defined in AltPluginDataFactory
      Returns:
      the the instance of AltPluginData for the given Type model

    • compute

      public int compute(RssRun rssRun)
      Compute.
      Parameters:
      rssRun - the rss run
      Returns:
      the int

    • addAltPluginData

      public void addAltPluginData(hec.rss.plugins.model.AltPluginData data)
      Adds the alt plugin data.
      Parameters:
      data - the data

    • setReplaceAll

      public void setReplaceAll(boolean replace)
      Sets the replace all.
      Parameters:
      replace - the new replace all

    • replaceAllReleaseOverrides

      public boolean replaceAllReleaseOverrides()
      Replace all with other alt.
      Returns:
      true, if successful

    • useOtherAltResults

      public boolean useOtherAltResults(String name)
      Returns if the particular controlled outlet uses another alternative's results for its release overrride.
      Parameters:
      name - the name
      Returns:
      true, if successful

    • getUseOtherAltName

      public String getUseOtherAltName(String name)
      Returns the name of the alternative used for the release overrides for controlled outlet.
      Parameters:
      name - the name
      Returns:
      the use other alt name

    • getUseOtherAltCollectionSequence

      public String getUseOtherAltCollectionSequence(String name)
      Returns the name of the collection sequence alternative used for the release overrides for controlled outlet.
      Parameters:
      name - the name
      Returns:
      the use other alt collection sequence

    • setReleaseOverridesAlt

      public void setReleaseOverridesAlt(String name, AltOverride ao)
      Sets the release values.
      Parameters:
      name - the name
      ao - the ao

    • setUseOtherAltResults

      public void setUseOtherAltResults(boolean set, String key)
      Sets the use other alt results.
      Parameters:
      set - the set
      key - the key

    • clearUserOtherAltOverrides

      public void clearUserOtherAltOverrides()

    • getTimeStepString

      public String getTimeStepString()
      get the TimeStep String. i.e. 1HOUR, 1DAY, 30MINUTE if the time step is not define, default it to 1HOUR
      Returns:
      the TimeStep String

    • addRun

      public void addRun(String run)
      Adds the run.
      Parameters:
      run - the run

    • getRunList

      public Vector getRunList()
      Gets the run list.
      Returns:
      the run list

    • deleteRun

      public void deleteRun(String run)
      Delete run.
      Parameters:
      run - the run

    • deleting

      public void deleting()
      Description copied from class: Manager
      called when the manager proxy is deleting the manager allows the manager to do any additional clean required.
      Overrides:
      deleting in class Manager

    • renameRun

      public void renameRun(String old, String newr)
      Rename run.
      Parameters:
      old - the old
      newr - the newr

    • getLastModifiedTime

      public long getLastModifiedTime()
      return the latest last modified time from either this or it's managers.
      Overrides:
      getLastModifiedTime in class Manager
      Returns:
      the last modified time

    • unloading

      public void unloading()
      called when the manager proxy is unloading the manager.
      Overrides:
      unloading in class Manager

    • saveChildManagers

      public boolean saveChildManagers()
      Description copied from class: Manager
      called when this Manager contains other Managers (ie an Alternative) so that it can tell all of it's child Managers to save. By default it just calls _proxyList.saveManager(hec.lang.UserId.getUserId(), this)
      Overrides:
      saveChildManagers in class Manager
      Returns:
      true if the save was successful

    • reLoadChildManagers

      public boolean reLoadChildManagers()
      Description copied from class: Manager
      called when this Manager contains other Managers (ie an Alternative) so that it can tell all of it's child Managers to reload. By default it just calls reLoadFile()
      Overrides:
      reLoadChildManagers in class Manager
      Returns:
      true if the reload was successful

    • setModified

      public void setModified(boolean modified)
      Description copied from class: NamedType
      Set the modified flag to true or false.
      Specified by:
      setModified in interface rma.lang.Modifiable
      Overrides:
      setModified in class Manager

    • saveManagerAs

      public Manager saveManagerAs(String directory, String filePrefix, ManagerProxyListContainer container)
      duplicate this, RssSystem and InputTsData. Saving out to new file.
      Overrides:
      saveManagerAs in class Manager
      Parameters:
      directory - the directory
      filePrefix - the file prefix
      container - the container
      Returns:
      the manager

    • refreshData

      public boolean refreshData(Manager origMgr)
      Description copied from class: Manager
      refresh this managers data from the origMgr's data
      Overrides:
      refreshData in class Manager

    • clone

      public Object clone()
      Description copied from class: NamedType
      Creates a new object of the same class as this object.
      It then initializes each of the new object's fields by assigning it the same value as the corresponding field in this object. No
      constructor is called.
      Overrides:
      clone in class NamedType

    • copyInto

      public boolean copyInto(RssAlt alt)
      Copy into.
      Parameters:
      alt - the alt
      Returns:
      true, if successful

    • copyGvDataSetsInto

      public boolean copyGvDataSetsInto(RssAlt fromAlt)

    • setInflowFactorType

      public void setInflowFactorType(int inflowType)
      Sets the inflow factor type.
      Parameters:
      inflowType - the new inflow factor type

    • getInflowFactorType

      public int getInflowFactorType()
      Gets the inflow factor type.
      Returns:
      the inflow factor type

    • setGlobalInflowFactor

      public void setGlobalInflowFactor(double factor)
      Sets the global inflow factor.
      Parameters:
      factor - the new global inflow factor

    • getGlobalInflowFactor

      public double getGlobalInflowFactor()
      Gets the global inflow factor.
      Returns:
      the global inflow factor

    • setLocationInflowFactors

      public void setLocationInflowFactors(List<InflowLocationFactor> inflowFactors)
      Sets the location inflow factors.
      Parameters:
      inflowFactors - the new location inflow factors

    • getLocationInflowFactors

      public List<InflowLocationFactor> getLocationInflowFactors()
      Gets the location inflow factors.
      Returns:
      the location inflow factors

    • getLocationInflowFactors

      public double[] getLocationInflowFactors(JunctionElement element, double[] factorArray)
      get the factor array for the JunctionElement.
      Parameters:
      element - the element
      factorArray - the factor array
      Returns:
      the location inflow factors

    • setUsingInflowFactors

      public void setUsingInflowFactors(boolean usingFactors)
      Sets the using inflow factors.
      Parameters:
      usingFactors - the new using inflow factors

    • isDefaultFlowCompute

      public boolean isDefaultFlowCompute()
      Checks if is default flow compute.
      Returns:
      true, if is default flow compute

    • getFlowComputeType

      public int getFlowComputeType()
      Gets the flow compute type.
      Returns:
      the flow compute type

    • isPerAvgFlow

      public boolean isPerAvgFlow()
      return true if period average flow calcs.
      Returns:
      true, if is per avg flow

    • getComputedFlowComputeType

      public int getComputedFlowComputeType()
      Gets the computed flow compute type.
      Returns:
      the computed flow compute type

    • isUsingInflowFactors

      public boolean isUsingInflowFactors()
      Checks if is using inflow factors.
      Returns:
      true, if is using inflow factors

    • getLocationInflowFactor

      public double getLocationInflowFactor(JunctionElement element, String localFlowName)
      Gets the location inflow factor.
      Parameters:
      element - the element
      localFlowName - the local flow name
      Returns:
      the location inflow factor

    • getHotstartOptions

      public HotstartOptions getHotstartOptions()
      Gets the hotstart options.
      Returns:
      the hotstart options

    • getComputeUnReg

      public boolean getComputeUnReg()
      return whether unregulated flow computations will be done.
      Returns:
      the compute un reg

    • setComputeUnReg

      public void setComputeUnReg(boolean computeUnReg)
      Sets the compute un reg.
      Parameters:
      computeUnReg - the new compute un reg

    • setComputeCumLoc

      public void setComputeCumLoc(boolean computeCumLoc)

    • getComputeCumLoc

      public boolean getComputeCumLoc()
      return whether unregulated flow computations will be done.
      Returns:
      the compute un reg

    • setCopyOverrides

      public void setCopyOverrides(boolean copyOverrides)
      set whether the release (and other) overrides get copied when the alternative is copied to/from the simulation area

    • getComputeHoldout

      public boolean getComputeHoldout()

    • setComputeHoldout

      public void setComputeHoldout(boolean computeHoldout)
      Sets the compute holdout.
      Parameters:
      computeHoldout - the new compute holdout

    • getLogLevel

      public int getLogLevel()
      Gets the log level.
      Returns:
      the log level

    • setLogLevel

      public void setLogLevel(int logLevel)
      Sets the log level.
      Parameters:
      logLevel - the new log level

    • getVersion

      public int getVersion()
      Gets the version.
      Returns:
      the version

    • getTimeStep

      public static int[] getTimeStep(RssAlt alt)
      Gets the time step.
      Parameters:
      alt - the alt
      Returns:
      [0] time step [1] timestep increment

    • getFlowComputeType

      public int getFlowComputeType(int timeStepSeconds)
      determine what flow compute type an alternative should be using, if its flow compute type isn't set (set to FLOW_COMPUTE_DEFAULT).
      Parameters:
      timeStepSeconds - the timestep in seconds in case the Alt's network is available.
      Returns:
      either FLOW_COMPUTE_INSTANT or FLOW_COMPUTE_PERAVG

    • initCompute

      public void initCompute()
      Inits the compute.

    • setUseYieldAnalysis

      public void setUseYieldAnalysis(boolean useYieldAnalysis)
      Sets the uses Yield Analysis flag.
      Parameters:
      useYieldAnalysis - the new use yield analysis

    • useYieldAnalysis

      public boolean useYieldAnalysis()
      Uses Yield Analysis.
      Returns:
      true, if successful

    • setUserName

      public void setUserName(String userName)
      Sets the user name.
      Parameters:
      userName - the new user name

    • toString

      public String toString()
      Overrides:
      toString in class Manager

    • addPluginSettings

      public void addPluginSettings(PluginSettings options)
      Adds the plugin settings.
      Parameters:
      options - the options

    • getPluginSettings

      public PluginSettings getPluginSettings(String clsname)
      Gets the plugin settings.
      Parameters:
      clsname - the clsname
      Returns:
      the plugin settings

    • getPluginDataList

      public List<hec.rss.plugins.model.AltPluginData> getPluginDataList()
      Gets the list of PluginData for the Alternative.
      Returns:
      List

    • clearPluginSettings

      public void clearPluginSettings(String clsname)
      Clear plugin settings.
      Parameters:
      clsname - the clsname

    • writeReport

      public boolean writeReport(BufferedWriter writer, RunTimeWindow rtw, RssRun run)
      Write report.
      Parameters:
      writer - the writer
      rtw - the rtw
      run - the run
      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

    • getComputeLauncher

      public hec.rss.compute.ResSimComputeLauncher getComputeLauncher()
      Gets the compute launcher.
      Returns:
      the compute launcher

    • setSystem

      public void setSystem(RssSystem system)
      don't call this method to set the system, use setSystemIndex().
      Parameters:
      system - the new system

    • setTSDataSets

      public void setTSDataSets(TSDataSet copyInputTsDataSet, TSDataSet copyOutputTsDataSet)
      don't call this method to set the TSDataSets.
      Parameters:
      copyInputTsDataSet - the copy input ts data set
      copyOutputTsDataSet - the copy output ts data set

    • setReservoirYieldAnalysis

      public void setReservoirYieldAnalysis(ReservoirYieldAnalysis yieldAnalysis)
      Sets the yield analysis.
      Parameters:
      yieldAnalysis - the new yield analysis

    • setReverseReservoirYieldAnalysis

      public void setReverseReservoirYieldAnalysis(ReverseReservoirYieldAnalysis yieldAnalysis)

    • setWaterAccountYieldAnalysis

      public void setWaterAccountYieldAnalysis(WaterAccountYieldAnalysis yieldAnalysis)

    • setReverseWaterAccountYieldAnalysis

      public void setReverseWaterAccountYieldAnalysis(ReverseWaterAccountYieldAnalysis yieldAnalysis)

    • setReservoirStorageVsYieldAnalysis

      public void setReservoirStorageVsYieldAnalysis(ReservoirStorageVsYieldAnalysis yieldAnalysis)

    • setSelectedYieldAnalysis

      public void setSelectedYieldAnalysis(YieldAnalysisType selectedYieldAnalysis)

    • getReservoirYieldAnalysis

      public ReservoirYieldAnalysis getReservoirYieldAnalysis()
      Gets the yield analysis.
      Returns:
      the yield analysis

    • getReverseReservoirYieldAnalysis

      public ReverseReservoirYieldAnalysis getReverseReservoirYieldAnalysis()

    • getWaterAccountYieldAnalysis

      public WaterAccountYieldAnalysis getWaterAccountYieldAnalysis()

    • getReverseWaterAccountYieldAnalysis

      public ReverseWaterAccountYieldAnalysis getReverseWaterAccountYieldAnalysis()

    • getReservoirStorageVsYieldAnalysis

      public ReservoirStorageVsYieldAnalysis getReservoirStorageVsYieldAnalysis()

    • getSelectedYieldAnalysis

      public YieldAnalysisType getSelectedYieldAnalysis()

    • getYieldAnalysis

      public YieldAnalysis getYieldAnalysis()

    • setWaterAccountSet

      public void setWaterAccountSet(WaterAccountSet waterAccountSet)
      Sets the water account set.
      Parameters:
      waterAccountSet - the new water account set

    • getWaterAccountSet

      public WaterAccountSet getWaterAccountSet()
      Gets the water account set.
      Returns:
      the water account set

    • setWaterAccountSetIndex

      public void setWaterAccountSetIndex(int index)

    • getWaterAccountSetIndex

      public int getWaterAccountSetIndex()

    • getInputTSVariantNames

      public List<String> getInputTSVariantNames()

    • getInputTSVariants

      public List<TsVariant> getInputTSVariants()

    • getTsVariant

      public TsVariant getTsVariant(String variantName)
      Parameters:
      variantName -
      Returns:

    • 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 elements, assume all records are active

    • getWaterQualityOptions

      public hec.rss.wq.model.AltWaterQualityOptions getWaterQualityOptions()
      Returns:
      the water quality options

    • hasWaterQualityOptions

      public boolean hasWaterQualityOptions()
      Returns:
      true if the alternative has water quality options

    • getObsWQDataPath

      public String getObsWQDataPath()
      Gets the obs water quality data path.
      Returns:
      the obs water quality variable data path

    • setObsWQDataSetPath

      public void setObsWQDataSetPath(String path)
      Sets the water qulaity obs data set path.
      Parameters:
      path - the new data set path

    • getObsWQTSDataSet

      public TSDataSet getObsWQTSDataSet(TsVariant variant)
      Retrieves the TSdata set for the water quality observed data
      Parameters:
      variant -
      Returns:

    • getObsWQTSDataSet

      public TSDataSet getObsWQTSDataSet(String variant, boolean hasNonDefaultInput)
      get the obs TSDataSet for water qulaity input for a particular variant Not implememnted yet. Waiting for use with Model Linking
      Parameters:
      variant - the variant name or null for the default TSDataSet
      Returns:
      the ts data set for water qualtiy for the variant

    • getObsWQTSDataSet

      public TSDataSet getObsWQTSDataSet()
      Gets the OBS TSDataSet used for water quality input by this alternative.
      Returns:
      the default observed tsDataSet for water quality

    • getObsWQPairedData

      public List<PairedDataContainer> getObsWQPairedData()

    • getObsWQPairedData

      public List<PairedDataContainer> getObsWQPairedData(RunTimeWindow rtw)

    • getObsWQPDCDataSet

      public PDCDataSet getObsWQPDCDataSet()

    • getObsWQPDCDataSet

      public PDCDataSet getObsWQPDCDataSet(RunTimeWindow rtw)

    • setUserInterface

      public UserInterface setUserInterface(UserInterface ui)
      Overrides:
      setUserInterface in class Manager
      Parameters:
      ui -
      Returns:

    • setUserInterface

      public mil.army.usace.hec.rmi.server.RemoteWrapper setUserInterface(mil.army.usace.hec.rmi.server.RemoteWrapper wrapper)
      Overrides:
      setUserInterface in class Manager

    • deleteVariant

      public boolean deleteVariant(TsVariant variant)
      delete the variant and all its datasets and their files
      Parameters:
      variant - the variant to delete
      Returns:
      true if the variant was deleted

    • hasbeenAccepted

      public boolean hasbeenAccepted()
      called when a Trial has been accepted. Need to do some cleanup of the trial

    • prepareForExtract

      public List<String> prepareForExtract(RunTimeWindow simPeriodRTW, RssAlt rssAlt, mil.army.usace.hec.rmi.csinterface.DSSManager dssFileManager)

    • getInputMetDataDSSFileName

      public String getInputMetDataDSSFileName()