Enum Class PFDLayoutPolicy.ProcessPosition

java.lang.Object

java.lang.Enum<PFDLayoutPolicy.ProcessPosition>

neqsim.process.processmodel.diagram.PFDLayoutPolicy.ProcessPosition

All Implemented Interfaces:

Serializable, Comparable<PFDLayoutPolicy.ProcessPosition>, Constable

Enclosing class:

PFDLayoutPolicy

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

Horizontal process position for left-to-right flow convention.

Oil & gas PFDs follow a left-to-right flow convention:

• Feed/inlet streams enter from the LEFT
• Processing equipment in the CENTER
• Product/outlet streams exit to the RIGHT

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
CENTER	Processing position - center of diagram.
INLET	Feed/inlet position - left side of diagram.
OUTLET	Product/outlet position - right side of diagram.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	description
private final int	horizontalRank

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ProcessPosition(int horizontalRank, String description)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the position description.
int	getHorizontalRank()	Gets the horizontal rank for left-to-right ordering.
static PFDLayoutPolicy.ProcessPosition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PFDLayoutPolicy.ProcessPosition[]	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

INLET

public static final PFDLayoutPolicy.ProcessPosition INLET

Feed/inlet position - left side of diagram.

CENTER

public static final PFDLayoutPolicy.ProcessPosition CENTER

Processing position - center of diagram.

OUTLET

public static final PFDLayoutPolicy.ProcessPosition OUTLET

Product/outlet position - right side of diagram.

Field Details

horizontalRank

private final int horizontalRank

description

private final String description

Constructor Details

ProcessPosition

private ProcessPosition(int horizontalRank,
 String description)

Method Details

values

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

getHorizontalRank

public int getHorizontalRank()

Gets the horizontal rank for left-to-right ordering.

Returns:

horizontal rank (0=left, higher=right)

getDescription

public String getDescription()

Gets the position description.

Returns:

description string