Enum Class WellScheduler.WellStatus

java.lang.Object
java.lang.Enum<WellScheduler.WellStatus>
neqsim.process.util.fielddevelopment.WellScheduler.WellStatus
All Implemented Interfaces:
Serializable, Comparable<WellScheduler.WellStatus>, Constable
Enclosing class:
WellScheduler

public static enum WellScheduler.WellStatus extends Enum<WellScheduler.WellStatus>
Well operational status.

Defines the possible states a well can be in during field operations. The status affects both production contribution and intervention scheduling.

Version:
1.0
Author:
ESOL
  • Enum Constant Details

  • Field Details

    • displayName

      private final String displayName
    • isProducing

      private final boolean isProducing
  • Constructor Details

    • WellStatus

      private WellStatus(String displayName, boolean isProducing)
  • Method Details

    • values

      public static WellScheduler.WellStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static WellScheduler.WellStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getDisplayName

      public String getDisplayName()
      Gets the display name for reports.
      Returns:
      human-readable status name
    • isProducing

      public boolean isProducing()
      Checks if the well produces in this status.
      Returns:
      true if well is producing