Package hec.rss.model

Class StorageZoneRules

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

public class StorageZoneRules extends NamedType implements Cloneable
A portion of a reservoir's storage pool where a particular operating strategy is defined.
See Also:
  • Constructor Details

  • Method Details

    • getOpSet

      public OpSet getOpSet()
    • setOpSet

      public void setOpSet(OpSet opSet)
    • removeRuleRef

      public void removeRuleRef(int ruleRefIndex)
      remove a rule reference from a storage zone rule set for a controller
    • getOpControllerZones

      public OpControllerZones getOpControllerZones()
    • getSortedZoneRuleRefs

      public Vector getSortedZoneRuleRefs()
      gets the rule references sorted in priority order
    • removeZoneObject

      public ZoneObject removeZoneObject(int zoneObjectIndex)
    • getActiveRuleRefs

      public List getActiveRuleRefs(RunTimeStep rts)
    • getSortedZoneObjects

      public List getSortedZoneObjects(boolean ascend)
      Returns a sorted list of zone objects.
      Parameters:
      ascend -
      Returns:
    • getSortedConditionalBlockRefs

      public List getSortedConditionalBlockRefs(boolean ascend)
    • getSortedZoneRuleRefs

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

      public Vector getZoneRuleRefs(Vector rvec)
      gets the rule references and appends them to the given vector
    • addRule

      public OpRuleRef addRule(OpRule rule)
    • addRule

      public OpRuleRef addRule(OpRule rule, int priority)
    • addConditionalBlock

      public ConditionalBlockRef addConditionalBlock(ConditionalBlock cb)
    • addConditionalBlock

      public ConditionalBlockRef addConditionalBlock(ConditionalBlock cb, int priority)
    • removeCondtionalBlockRef

      public ConditionalBlockRef removeCondtionalBlockRef(int cbBlockIndex)
    • setOpControllerZone

      public void setOpControllerZone(OpControllerZones ocz)
    • getStorageZoneIndex

      public int getStorageZoneIndex()
    • clone

      public Object clone()
      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
    • getOpRuleRef

      public OpRuleRef getOpRuleRef(int ruleRefIndex)
    • 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