Enum Class PFDLayoutPolicy.PhaseZone

java.lang.Object

java.lang.Enum<PFDLayoutPolicy.PhaseZone>

neqsim.process.processmodel.diagram.PFDLayoutPolicy.PhaseZone

All Implemented Interfaces:

Serializable, Comparable<PFDLayoutPolicy.PhaseZone>, Constable

Enclosing class:

PFDLayoutPolicy

public static enum PFDLayoutPolicy.PhaseZone
extends Enum<PFDLayoutPolicy.PhaseZone>

Vertical phase zone for gravity-based positioning.

Oil & gas PFDs follow gravity conventions for vertical positioning:

• Gas processing equipment at TOP (lightest phase)
• Oil processing equipment in MIDDLE (intermediate density)
• Water processing equipment at BOTTOM (heaviest phase)

Version:

1.0

Author:

NeqSim

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GAS_TOP	Gas zone - top of diagram.
OIL_MIDDLE	Oil zone - middle of diagram.
SEPARATION_CENTER	Mixed/separation zone - center anchor.
UNKNOWN	Unknown zone.
WATER_BOTTOM	Water zone - bottom of diagram.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	color
private final String	label
private final int	verticalRank

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PhaseZone(int verticalRank, String color, String label)

Method Summary

Modifier and Type	Method	Description
String	getColor()	Gets the zone color.
String	getLabel()	Gets the zone label.
int	getVerticalRank()	Gets the vertical rank for top-to-bottom ordering.
static PFDLayoutPolicy.PhaseZone	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PFDLayoutPolicy.PhaseZone[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GAS_TOP

public static final PFDLayoutPolicy.PhaseZone GAS_TOP

Gas zone - top of diagram.

OIL_MIDDLE

public static final PFDLayoutPolicy.PhaseZone OIL_MIDDLE

Oil zone - middle of diagram.

WATER_BOTTOM

public static final PFDLayoutPolicy.PhaseZone WATER_BOTTOM

Water zone - bottom of diagram.

SEPARATION_CENTER

public static final PFDLayoutPolicy.PhaseZone SEPARATION_CENTER

Mixed/separation zone - center anchor.

UNKNOWN

public static final PFDLayoutPolicy.PhaseZone UNKNOWN

Unknown zone.

Field Details

verticalRank

private final int verticalRank

color

private final String color

label

private final String label

Constructor Details

PhaseZone

private PhaseZone(int verticalRank,
 String color,
 String label)

Method Details

values

public static PFDLayoutPolicy.PhaseZone[] 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 PFDLayoutPolicy.PhaseZone 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

getVerticalRank

public int getVerticalRank()

Gets the vertical rank for top-to-bottom ordering.

Returns:

vertical rank (0=top, higher=bottom)

getColor

public String getColor()

Gets the zone color.

Returns:

hex color string

getLabel

public String getLabel()

Gets the zone label.

Returns:

display label