Enum Class StudyClass

java.lang.Object
java.lang.Enum<StudyClass>
neqsim.process.mechanicaldesign.StudyClass
All Implemented Interfaces:
Serializable, Comparable<StudyClass>, Constable
public enum StudyClass extends Enum<StudyClass>
Study classification for engineering deliverables.

Defines which deliverables are required for each study class according to oil & gas industry practice. Class A studies (FEED/Detailed Design) require the full set of engineering documents while Class B (Concept/Pre-FEED) requires a reduced set.

Study class deliverable requirements
Deliverable Class A Class B Class C
Thermal utility summary Yes Yes No
Process flow diagram Yes Yes Yes
Alarm/trip schedule Yes No No
Spare parts inventory Yes No No
Fire scenario assessment Yes Yes No
Noise assessment Yes No No
Instrument schedule Yes Yes No
Version:
1.0
Author:
esol
See Also:

  • Enum Constant Details

    • CLASS_A

      public static final StudyClass CLASS_A
      Class A: Full FEED / Detailed Design study. All deliverables required.

    • CLASS_B

      public static final StudyClass CLASS_B
      Class B: Concept / Pre-FEED study. Reduced deliverable set.

    • CLASS_C

      public static final StudyClass CLASS_C
      Class C: Screening study. Minimal deliverable set.

  • Field Details

  • Constructor Details

    • StudyClass

      private StudyClass(String displayName, Set<StudyClass.DeliverableType> requiredDeliverables)
      Constructor.
      Parameters:
      displayName - human-readable name
      requiredDeliverables - set of required deliverable types

  • Method Details

    • values

      public static StudyClass[] 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 StudyClass 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()
      Get the display name of this study class.
      Returns:
      display name

    • getRequiredDeliverables

      public Set<StudyClass.DeliverableType> getRequiredDeliverables()
      Get the set of required deliverable types for this study class.
      Returns:
      unmodifiable set of required deliverables

    • requires

      public boolean requires(StudyClass.DeliverableType type)
      Check if a specific deliverable type is required for this study class.
      Parameters:
      type - the deliverable type to check
      Returns:
      true if the deliverable is required

    • allDeliverables

      private static Set<StudyClass.DeliverableType> allDeliverables()
      Build a set of all deliverable types.
      Returns:
      set containing all deliverable types

    • toSet

      private static Set<StudyClass.DeliverableType> toSet(StudyClass.DeliverableType... types)
      Convenience helper to build an unmodifiable set from varargs.
      Parameters:
      types - deliverable types
      Returns:
      set of types

    • toString

      public String toString()
      Overrides:
      toString in class Enum<StudyClass>