Enum Class EquipmentRole

java.lang.Object

java.lang.Enum<EquipmentRole>

neqsim.process.processmodel.diagram.EquipmentRole

All Implemented Interfaces:

Serializable, Comparable<EquipmentRole>, Constable

public enum EquipmentRole
extends Enum<EquipmentRole>

Classifies process equipment by its functional role in the process.

This classification is used by the layout intelligence layer to determine optimal positioning in professional PFD diagrams. Equipment role follows oil & gas industry conventions:

• GAS - Equipment handling predominantly gas phase (compressors, gas coolers)
• LIQUID - Equipment handling predominantly liquid phase (pumps, liquid heaters)
• SEPARATOR - Phase separation equipment (separators, scrubbers, flash drums)
• MIXED - Equipment handling mixed phases (heat exchangers, pipes)
• FEED - Feed/inlet streams
• PRODUCT - Product/outlet streams
• UTILITY - Utility equipment (coolers, heaters with external utility)
• CONTROL - Control equipment (valves, controllers)

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
CONTROL	Control equipment - positioned inline with controlled equipment.
FEED	Feed/inlet streams - positioned at left of diagram.
GAS	Gas processing equipment - positioned in upper section of PFD.
LIQUID	Liquid processing equipment - positioned in lower section of PFD.
MIXED	Mixed phase equipment - positioned based on context.
PRODUCT	Product/outlet streams - positioned at right of diagram.
SEPARATOR	Separator equipment - anchor point, gas exits top, liquid exits bottom.
UNKNOWN	Unknown equipment role.
UTILITY	Utility equipment - positioned at side/periphery.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	defaultColor	Default color for this role (hex).
private final String	displayName	Display name for this role.
private final String	preferredZone	Preferred zone in PFD layout.
private final int	rankPriority	Rank priority for vertical layout (0=top, higher=bottom).

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EquipmentRole(String displayName, String preferredZone, String defaultColor, int rankPriority)	Constructor for EquipmentRole.

Method Summary

Modifier and Type	Method	Description
String	getDefaultColor()	Gets the default color in hex format.
String	getDisplayName()	Gets the display name.
String	getPreferredZone()	Gets the preferred zone for layout.
int	getRankPriority()	Gets the rank priority for vertical layout (0 = top, higher = bottom).
static EquipmentRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EquipmentRole[]	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

public static final EquipmentRole GAS

Gas processing equipment - positioned in upper section of PFD.

LIQUID

public static final EquipmentRole LIQUID

Liquid processing equipment - positioned in lower section of PFD.

SEPARATOR

public static final EquipmentRole SEPARATOR

Separator equipment - anchor point, gas exits top, liquid exits bottom.

MIXED

public static final EquipmentRole MIXED

Mixed phase equipment - positioned based on context.

FEED

public static final EquipmentRole FEED

Feed/inlet streams - positioned at left of diagram.

PRODUCT

public static final EquipmentRole PRODUCT

Product/outlet streams - positioned at right of diagram.

UTILITY

public static final EquipmentRole UTILITY

Utility equipment - positioned at side/periphery.

CONTROL

public static final EquipmentRole CONTROL

Control equipment - positioned inline with controlled equipment.

UNKNOWN

public static final EquipmentRole UNKNOWN

Unknown equipment role.

Field Details

displayName

private final String displayName

Display name for this role.

preferredZone

private final String preferredZone

Preferred zone in PFD layout.

defaultColor

private final String defaultColor

Default color for this role (hex).

rankPriority

private final int rankPriority

Rank priority for vertical layout (0=top, higher=bottom).

Constructor Details

EquipmentRole

private EquipmentRole(String displayName,
 String preferredZone,
 String defaultColor,
 int rankPriority)

Constructor for EquipmentRole.

Parameters:

displayName - human-readable name

preferredZone - preferred zone in layout

defaultColor - default color in hex format

rankPriority - rank priority for vertical layout

Method Details

values

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

Returns:

display name

getPreferredZone

public String getPreferredZone()

Gets the preferred zone for layout.

Returns:

preferred zone

getDefaultColor

public String getDefaultColor()

Gets the default color in hex format.

Returns:

hex color string

getRankPriority

public int getRankPriority()

Gets the rank priority for vertical layout (0 = top, higher = bottom).

Returns:

rank priority