Package hec.model

Class Conditional

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

public class Conditional extends NamedType implements AsciiSerializable
See Also:
  • Field Details

  • Constructor Details

    • Conditional

      public Conditional()
    • Conditional

      public Conditional(int conditionalType)
      Create a new Conditional object
  • Method Details

    • decreaseConditionalObjectPriority

      public void decreaseConditionalObjectPriority(Object obj)
    • increaseConditionalObjectPriority

      public void increaseConditionalObjectPriority(Object obj)
    • moveToBottomPriority

      public void moveToBottomPriority(Object obj)
    • moveToTopPriority

      public void moveToTopPriority(Object obj)
    • updateParentData

      public void updateParentData()
    • setParent

      public void setParent(ConditionalBlock cb)
    • getParent

      public ConditionalBlock getParent()
    • getParentElement

      public NamedType getParentElement()
      override to return correct Parent element
      Returns:
    • removeCondtionalObject

      public boolean removeCondtionalObject(Object obj)
    • clone

      public Conditional clone()
      Description copied from class: NamedType
      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
    • getConditionalType

      public int getConditionalType()
    • getConditionalTypeString

      public String getConditionalTypeString()
    • conditionalTreeToString

      public String conditionalTreeToString()
    • toString

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

      public List getConditionalObjects(boolean evaluateSubBlocks)
      return the Objects held by this conditional
      Returns:
    • getConditionalObjects

      public List getConditionalObjects(List objectList, boolean recurse, RunTimeStep rts, boolean evaluateSubBlocks)
    • initializeCompute

      public boolean initializeCompute(RunTimeWindow rtw)
    • evaluate

      public boolean evaluate(RunTimeStep rts)
      Evaluates the conditions and returns true or false depending on the value of the ConditionalItem expressions that this object contains.
      Returns:
    • printErrorMessage

      protected void printErrorMessage(String msg)
    • clearConditionalItems

      public void clearConditionalItems()
    • addConditionalItem

      public void addConditionalItem(ConditionalItem ci)
    • addConditionalBlock

      public void addConditionalBlock(ConditionalBlock cb)
    • getContitionalBlocks

      public List<ConditionalBlock> getContitionalBlocks()
    • getConditionalChildren

      public List getConditionalChildren()
      Returns a list of children that are part of this object. This would include all ConditionalBlocks or other objects that are dependant on this conditional.
      Returns:
    • deleteConditionalBlock

      public ConditionalBlock deleteConditionalBlock(int cbBlockIndex)
    • getChildCount

      public int getChildCount()
      return the number of Conditional items this conditional holds
      Returns:
    • getConditionalItems

      public List getConditionalItems()
    • 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
    • shouldTreeNodeExpand

      public boolean shouldTreeNodeExpand()
      Returns:
    • setTreeNodeExpanded

      public void setTreeNodeExpanded(boolean expanded)
      Parameters:
      expanded -