Package hec.rss.model

Class RssOutput

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.rss.model.RssOutput
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, RssModelVariableConstants, RssReturnStatusConstants, Serializable, Cloneable, Comparable, Observer, mil.army.usace.hec.rmi.csinterface.CallBackInterface, rma.lang.Modifiable
public class RssOutput extends NamedType implements Serializable, AsciiSerializable, RssReturnStatusConstants, RssModelVariableConstants, mil.army.usace.hec.rmi.csinterface.CallBackInterface
Manages the summary output information generated by a single execution of the RSS model.
See Also:

  • Constructor Details

    • RssOutput

      public RssOutput()
      Instantiates a new rss output.

  • Method Details

    • setUnitSystem

      public void setUnitSystem(int unitSystem)
      Sets the unitSystem that is going to be used by the output data of and RSS run.
      Parameters:
      unitSystem - the new unit system

    • getReservoirSummaryStrArray

      public Object[][] getReservoirSummaryStrArray(RssSystem system, String key)
      Gets the reservoir summary str array.
      Parameters:
      system - the system
      key - the key
      Returns:
      the reservoir summary str array

    • getReservoirSummaryStrArray

      public Object[][] getReservoirSummaryStrArray(RssSystem system, Map tsSummaryTable)
      Gets the reservoir summary str array.
      Parameters:
      system - the system
      tsSummaryTable - the ts summary table
      Returns:
      the reservoir summary str array

    • getReservoirSummaryStrArray

      public Object[][] getReservoirSummaryStrArray(RssSystem system, String reportTime, RssRun run, String mapKey)
      returns a string array used for reporting reservoir summary information.
      Parameters:
      system - the system
      reportTime - the report time
      run - the run
      Returns:
      the reservoir summary str array

    • getFlowSummaryStrArray

      public Object[][] getFlowSummaryStrArray(RssSystem system, String key)
      Gets the flow summary str array.
      Parameters:
      system - the system
      key - the key
      Returns:
      the flow summary str array

    • getStorageForReservoir

      public double[] getStorageForReservoir(RssSystem system, String resName, String key)
      Parameters:
      system -
      resName -
      key -
      Returns:
      avg/min/max

    • getControlReleaseForReservoir

      public double[] getControlReleaseForReservoir(RssSystem system, String resName, String key)
      Parameters:
      system -
      resName -
      key -
      Returns:
      avg/min/max

    • getUncontrolReleaseForReservoir

      public double[] getUncontrolReleaseForReservoir(RssSystem system, String resName, String key)
      Parameters:
      system -
      resName -
      key -
      Returns:
      avg/min/max

    • getElevForReservoir

      public double[] getElevForReservoir(RssSystem system, String resName, String key)
      Parameters:
      system -
      resName -
      key -
      Returns:
      avg/min/max

    • getFlowSummaryStrArray

      public Object[][] getFlowSummaryStrArray(RssSystem system, Map tsSummaryTable)
      returns a string array used for reporting flow summary information.
      Parameters:
      system - the system
      tsSummaryTable - the ts summary table
      Returns:
      the flow summary str array

    • getFlowSummaryStrArray

      public Object[][] getFlowSummaryStrArray(RssSystem system, String reportTime, RssRun run, String mapKey)
      Gets the flow summary str array.
      Parameters:
      system - the system
      reportTime - the report time
      run - the run
      Returns:
      the flow summary str array

    • getStageSummaryStrArray

      public Object[][] getStageSummaryStrArray(RssSystem system, String key)
      Gets the stage summary str array.
      Parameters:
      system - the system
      key - the key
      Returns:
      the stage summary str array

    • getStageSummaryStrArray

      public Object[][] getStageSummaryStrArray(RssSystem system, Map tsSummaryTable)
      returns a string array used for reporting stage summary information.
      Parameters:
      system - the system
      tsSummaryTable - the ts summary table
      Returns:
      the stage summary str array

    • getStageSummaryStrArray

      public Object[][] getStageSummaryStrArray(RssSystem system, String reportTime, RssRun run, String mapKey)
      returns a string array used for reporting stage summary information for a specific time.
      Parameters:
      system - the system
      reportTime - the report time
      run - the run
      tsSummaryTable - the ts summary table
      Returns:
      the stage summary str array

    • getPowerSummaryStrArray

      public Object[][] getPowerSummaryStrArray(RssSystem system, String key)
      Gets the power summary str array.
      Parameters:
      system - the system
      key - the key
      Returns:
      the power summary str array

    • getPowerSummaryStrArray

      public Object[][] getPowerSummaryStrArray(RssSystem system, Map tsSummaryTable)
      returns a string array used for reporting power summary information.
      Parameters:
      system - the system
      tsSummaryTable - the ts summary table
      Returns:
      the power summary str array

    • getPowerSummaryStrArray

      public Object[][] getPowerSummaryStrArray(RssSystem system, String reportTime, RssRun run, String mapKey)
      returns a string array used for reporting power summary information for a specific time.
      Parameters:
      system - the system
      reportTime - the report time
      run - the run
      tsRecordTable - the ts record table
      Returns:
      the power summary str array

    • getGatesSummaryStrArray

      public Object[][] getGatesSummaryStrArray(RssSystem system, String key)
      Gets the gates summary str array.
      Parameters:
      system - the system
      key - the key
      Returns:
      the gates summary str array

    • getGatesSummaryStrArray

      public Object[][] getGatesSummaryStrArray(RssSystem system, Map tsSummaryTable)
      returns a string array used for reporting gates summary information.
      Parameters:
      system - the system
      tsSummaryTable - the ts summary table
      Returns:
      the gates summary str array

    • getGatesSummaryStrArray

      public Object[][] getGatesSummaryStrArray(RssSystem system, String reportTime, RssRun run, String mapKey)
      returns a string array used for reporting gates summary information for a specific time.
      Parameters:
      system - the system
      reportTime - the report time
      run - the run
      tsSummaryTable - the ts summary table
      Returns:
      the gates summary str array

    • addTSRecordSummaryTable

      public void addTSRecordSummaryTable(String key, Hashtable table)
      appends all records in the given table to the tsSummaryTable, over-writes entries with duplicate keys.
      Parameters:
      key - the key
      table - the table

    • notify

      public void notify(String message)
      Specified by:
      notify in interface mil.army.usace.hec.rmi.csinterface.CallBackInterface

    • removeCallBack

      public void removeCallBack()
      Removes the call back.

    • setIdentifier

      public void setIdentifier(Identifier id)
      Sets the identifier.
      Parameters:
      id - the new identifier

    • readFile

      public boolean readFile()
      Read file.
      Returns:
      true, if successful

    • readFile

      public boolean readFile(Identifier id)
      Read file.
      Parameters:
      id - the id
      Returns:
      true, if successful

    • 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