Package hec.rss.model

Class PrescribedOpItem

java.lang.Object
hec.rss.model.PrescribedOpItem
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, Serializable, Cloneable
public class PrescribedOpItem extends Object implements AsciiSerializable, Serializable, Cloneable
See Also:

  • Field Details

    • PRESCRIB_UNDEF

      public static final int PRESCRIB_UNDEF
      See Also:

    • PRESCRIB_SET_RELEASE

      public static final int PRESCRIB_SET_RELEASE
      See Also:

    • PRESCRIB_SET_REL_DELTA_INFLOW

      public static final int PRESCRIB_SET_REL_DELTA_INFLOW
      See Also:

    • PRESCRIB_HOLD_RELEASE

      public static final int PRESCRIB_HOLD_RELEASE
      See Also:

    • PRESCRIB_SET_GATE

      public static final int PRESCRIB_SET_GATE
      See Also:

    • PRESCRIB_ELEV_TARGET

      public static final int PRESCRIB_ELEV_TARGET
      See Also:

    • PRESCRIB_ELEV_CHANGE

      public static final int PRESCRIB_ELEV_CHANGE
      See Also:

    • PRESCRIB_HOLD_GATE

      public static final int PRESCRIB_HOLD_GATE
      See Also:

    • PRESCRIB_HOLD_ELEV

      public static final int PRESCRIB_HOLD_ELEV
      See Also:

    • PRESCRIB_ELEV_DELTA

      public static final int PRESCRIB_ELEV_DELTA
      See Also:

    • PRESCRIB_SET_REL_PERCENT_INFLOW

      public static final int PRESCRIB_SET_REL_PERCENT_INFLOW
      See Also:

    • PRESCRIB_HOLD_PREV_REL

      public static final int PRESCRIB_HOLD_PREV_REL
      See Also:

    • PRESCRIB_HOLD_PREV_GATE

      public static final int PRESCRIB_HOLD_PREV_GATE
      See Also:

    • PRESCRIB_OP_STRINGS

      public static final String[] PRESCRIB_OP_STRINGS

    • PRESCRIB_OP_DESCRIP

      public static final String[] PRESCRIB_OP_DESCRIP

    • PRESCRIB_OP_UNITS_PARAMID

      public static final int[] PRESCRIB_OP_UNITS_PARAMID

    • PRESCRIB_OP_ENDTIME_REQD

      public static final boolean[] PRESCRIB_OP_ENDTIME_REQD

    • PRESCRIB_OP_VALUE_NOTUSED

      public static final boolean[] PRESCRIB_OP_VALUE_NOTUSED

    • PRESCRIB_OP_RES_STRINGS

      public static final String[] PRESCRIB_OP_RES_STRINGS

    • PRESCRIB_OP_OUTLET_STRINGS

      public static final String[] PRESCRIB_OP_OUTLET_STRINGS

    • PRESCRIB_OP_GATE_STRINGS

      public static final String[] PRESCRIB_OP_GATE_STRINGS

    • _startTime

      protected HecTime _startTime

    • _endTime

      protected HecTime _endTime

    • _opCode

      protected int _opCode

    • _value

      protected double _value

  • Constructor Details

    • PrescribedOpItem

      public PrescribedOpItem()

    • PrescribedOpItem

      public PrescribedOpItem(HecTime start, HecTime end, int code, double val)

  • Method Details

    • initializeCompute

      public boolean initializeCompute()

    • isEndTimeReqd

      public boolean isEndTimeReqd()

    • isValueNotUsed

      public boolean isValueNotUsed()

    • getStartTime

      public HecTime getStartTime()

    • getEndTime

      public HecTime getEndTime()

    • setStartTime

      public void setStartTime(HecTime time)

    • setEndTime

      public void setEndTime(HecTime time)

    • getOpCode

      public int getOpCode()

    • getValue

      public double getValue()

    • setValue

      public void setValue(double value)
      Set the item value
      Parameters:
      value - the desired value

    • setOpCodeString

      public void setOpCodeString(String opCodeStr)
      Set the OpCode based on a string
      Parameters:
      opCodeStr - a string matching one of the standard op code strings

    • getOpCodeString

      public String getOpCodeString()
      get the string name base on this object's OpCode
      Returns:
      the OpCode String name

    • getOpCodeDescription

      public String getOpCodeDescription()

    • getUnitsParamId

      public int getUnitsParamId()

    • clone

      public PrescribedOpItem clone()
      Overrides:
      clone in class Object

    • 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

    • startIsLaterThan

      public boolean startIsLaterThan(HecTime htime)

    • endIsAtOrAfter

      public boolean endIsAtOrAfter(HecTime htime)