Package hec.rss.model

Class SystemStorageZone

All Implemented Interfaces:
AsciiSerializable, FieldAccessor, AltInputReportInfc, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable

public class SystemStorageZone extends NamedType implements Serializable, AsciiSerializable, Cloneable, AltInputReportInfc
SystemStorageZone - Represents the storage zone model for a system of reservoirs. The System storage zone is a combination of upper and lower bound storage zone for all reservoirs in the system. It also contains a list of %storage for each reservoir in the system.
See Also:
  • Field Details

    • _systemOpSet

      protected transient ResSystemOpSet _systemOpSet
      A reference ot the parent owner of this operation set
  • Constructor Details

    • SystemStorageZone

      public SystemStorageZone()
    • SystemStorageZone

      public SystemStorageZone(int idx, String name, String desc)
  • Method Details

    • getNumResevoirStorages

      public int getNumResevoirStorages()
    • getReservoir

      public ReservoirElement getReservoir(int id)
      Returns the resevoir for the given reservoir ID.
    • getSystemOpSet

      public ResSystemOpSet getSystemOpSet()
    • setParent

      public void setParent(ResSystemOpSet parent)
      Sets the parent owner of this object
    • toString

      public String toString()
      Overrides:
      toString in class NamedType
    • getSystemStorage

      public SystemReservoirStorage getSystemStorage(int resid)
      Returns a SystemStorage object for a given reservior id
    • deleteSystemStorage

      public void deleteSystemStorage(int resID)
      Deletes a Percentange storage that is indexed by then given reservior index
    • deleteZoneBounds

      public void deleteZoneBounds(int resID)
      Deletes a Zone Bounds that references opsets indexed by the given reservoir index
    • getStorageZoneBounds

      public ZoneBounds getStorageZoneBounds(int resID)
      Returns a ZoneBounds object for a give reservoir ID
    • getAllStorageZoneBounds

      public Vector getAllStorageZoneBounds()
      Returns a list of Zone Bounds. Not sorted in any order
    • getDefaultZoneBounds

      public ZoneBounds getDefaultZoneBounds()
    • addSystemReservoirStorage

      public void addSystemReservoirStorage(ReservoirElement elem, SystemReservoirStorage srs)
      adds a system reservoir storage to this storage zone. Overwrites any object already stored for this reservoir.
    • addStorageZoneBounds

      public void addStorageZoneBounds(ReservoirElement elem, ZoneBounds zb)
      adds a zone bounds to this storage zone. Will overwrite any zone bounds used by this reservoir
    • addSystemRuleReference

      public SystemOpRuleRef addSystemRuleReference(SystemOpRule rule)
      Addes a rule reference to the storage zone.
    • removeRuleRef

      public void removeRuleRef(SystemOpRule rule)
      Removes a SystemOpRuleRef for the corresponding SystemOpRule
    • getSortedZoneRuleRefs

      public Vector getSortedZoneRuleRefs(boolean ascend)
      gets the rule references sorted in priority order
    • clone

      public Object clone()
      Returns a copy of this object. The System Rule Id's are copied but a reference between the owner class (Parent) and the System Rule are passed to the clone(); In other words the clone points to the same parent and System Rule as this class
      Overrides:
      clone in class NamedType
    • 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
    • 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