Enum Class FlowAssuranceResult
- All Implemented Interfaces:
Serializable, Comparable<FlowAssuranceResult>, Constable
Result classification for flow assurance screening.
Represents a three-tier envelope classification for flow assurance parameters such as hydrate risk, wax deposition, and corrosion.
- Version:
- 1.0
- Author:
- ESOL
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum Constants -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateFlowAssuranceResult(String displayName, String description) -
Method Summary
Modifier and TypeMethodDescriptioncombine(FlowAssuranceResult other) Combines two results, returning the more severe.Gets the description.Gets the display name.booleanChecks if this result blocks development.booleanisSafe()Checks if this result indicates safe operation.booleanChecks if this result requires attention.static FlowAssuranceResultReturns the enum constant of this class with the specified name.static FlowAssuranceResult[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
PASS
Operating conditions are clearly within safe envelope. No flow assurance interventions required. -
MARGINAL
Operating conditions are near envelope boundaries. Flow assurance mitigation may be required under some scenarios. -
FAIL
Operating conditions exceed safe envelope. Flow assurance mitigation is mandatory.
-
-
Field Details
-
displayName
-
description
-
-
Constructor Details
-
FlowAssuranceResult
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
getDisplayName
-
getDescription
-
isSafe
public boolean isSafe()Checks if this result indicates safe operation.- Returns:
- true if PASS
-
needsAttention
public boolean needsAttention()Checks if this result requires attention.- Returns:
- true if MARGINAL or FAIL
-
isBlocking
public boolean isBlocking()Checks if this result blocks development.- Returns:
- true if FAIL
-
combine
Combines two results, returning the more severe.- Parameters:
other- other result- Returns:
- combined (worst-case) result
-