Package hec.rss.model

Class ReleaseAllocation

java.lang.Object
hec.rss.model.ReleaseAllocation
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, AltInputReportInfc, Serializable, Cloneable

public class ReleaseAllocation extends Object implements AsciiSerializable, Cloneable, AltInputReportInfc

Title: General CWMS Framework

Description:

Copyright: Copyright (c) 2002

Company: RMA Inc.

See Also:
  • Field Details

  • Constructor Details

    • ReleaseAllocation

      public ReleaseAllocation()
    • ReleaseAllocation

      public ReleaseAllocation(int releaseAllocationType)
  • Method Details

    • getName

      public String getName()
    • setName

      public void setName(String name)
    • setDescription

      public void setDescription(String descrition)
    • clone

      public Object clone() throws CloneNotSupportedException
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException
    • getAllocationType

      public int getAllocationType()
      type of allocation, one of SEQUENTIAL_RELEASE, STEPPED_RELEASE, or BALANCED_RELEASE
    • getAllocationTypeString

      public String getAllocationTypeString()
    • setAllocationType

      public void setAllocationType(int type)
      type of allocation, one of SEQUENTIAL_RELEASE, STEPPED_RELEASE, or BALANCED_RELEASE
      Parameters:
      type -
    • setAllocationType

      public void setAllocationType(String typeName)
    • addReleaseElement

      public void addReleaseElement(Object obj)
    • setReleaseUnits

      public void setReleaseUnits(int units)
      units type when allocation type == STEPPED_RELEASE
      Parameters:
      units -
    • setReleaseUnits

      public void setReleaseUnits(String units)
    • getAllocationList

      public List getAllocationList()
      for sequential type holds the ordered list of controllers indexes in intContainers for balanced type holds the IntToDoubleContainer for controller ids and weights for sequential type holds the IntToDoubleArrayContainer for the controller id and capacities.
    • getReleaseUnits

      public int getReleaseUnits()
    • getReleaseUnitsString

      public String getReleaseUnitsString()
    • paramString

      public String paramString()
    • 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
      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
      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