Package hec.rss.model

Class DayOfWeekMultiplier

java.lang.Object
hec.rss.model.DayOfWeekMultiplier
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, AltInputReportInfc, Serializable, Cloneable
public class DayOfWeekMultiplier extends Object implements Serializable, Cloneable, AsciiSerializable, AltInputReportInfc
DayOfWeekMultiplier.java This object consists of an array of doubles that act as a multiplier value for each day of the week, MONDAY-SUNDAY
See Also:

  • Field Details

    • SUNDAY

      public static int SUNDAY
      Static definition values for each day. Act as indexes into the multiplier array

    • MONDAY

      public static int MONDAY

    • TUESDAY

      public static int TUESDAY

    • WEDNSDAY

      public static int WEDNSDAY

    • THURSDAY

      public static int THURSDAY

    • FRIDAY

      public static int FRIDAY

    • SATURDAY

      public static int SATURDAY

  • Constructor Details

    • DayOfWeekMultiplier

      public DayOfWeekMultiplier()

  • Method Details

    • isDefaults

      public boolean isDefaults()
      returns true if all multipliers == 1

    • getLargestMultiplier

      public double getLargestMultiplier()

    • getMultiplier

      public double getMultiplier(int day)
      Returns the multiplier for a given day

    • getMultiplier

      public double getMultiplier(HecTime hecTime)
      Determines the day of week for the HecTime and returns the day of week multiplier

    • getMultiplier

      public double getMultiplier(RunTimeStep rts)
      Determines the day of week for the RunTimeStep.step and returns the day of week multiplier

    • setMultiplier

      public void setMultiplier(int day, double mult)
      Sets the multiplier for a given day

    • clone

      public Object clone() throws CloneNotSupportedException
      Clones this object
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException

    • 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