Enum Class DiagramDetailLevel

java.lang.Object

java.lang.Enum<DiagramDetailLevel>

neqsim.process.processmodel.diagram.DiagramDetailLevel

All Implemented Interfaces:

Serializable, Comparable<DiagramDetailLevel>, Constable

public enum DiagramDetailLevel
extends Enum<DiagramDetailLevel>

Defines the level of detail to include in process flow diagrams.

Different detail levels are appropriate for different audiences and use cases:

• CONCEPTUAL - High-level overview for teaching, AI agents, documentation
• ENGINEERING - Full PFD with all process data, suitable for engineering review
• DEBUG - Maximum detail including solver info, stream compositions, etc.

This mirrors modes in commercial simulators like UniSim and Aspen HYSYS.

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
CONCEPTUAL	Conceptual level - clean, simplified diagram.
DEBUG	Debug level - maximum detail for troubleshooting.
ENGINEERING	Engineering level - full PFD with process data.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	compactLabels	Whether to use compact node labels.
private final boolean	showCompositions	Whether to show stream compositions.
private final boolean	showConditions	Whether to show process conditions (T, P).
private final boolean	showFlowRates	Whether to show flow rates.
private final boolean	showSpecifications	Whether to show equipment specifications.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DiagramDetailLevel(boolean showConditions, boolean showFlowRates, boolean showCompositions, boolean showSpecifications, boolean compactLabels)	Constructor for DiagramDetailLevel.

Method Summary

Modifier and Type	Method	Description
boolean	showCompositions()	Whether to show stream compositions.
boolean	showConditions()	Whether to show process conditions (temperature, pressure).
boolean	showFlowRates()	Whether to show flow rates.
boolean	showSpecifications()	Whether to show equipment specifications.
boolean	useCompactLabels()	Whether to use compact node labels.
static DiagramDetailLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DiagramDetailLevel[]	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

CONCEPTUAL

public static final DiagramDetailLevel CONCEPTUAL

Conceptual level - clean, simplified diagram.

Shows:

• Equipment names and types
• Stream connections
• Phase indicators (gas/liquid)

Hides:

• Process conditions (T, P)
• Flow rates
• Compositions
• Equipment specifications

Use for: Teaching, AI agents, high-level documentation

ENGINEERING

public static final DiagramDetailLevel ENGINEERING

Engineering level - full PFD with process data.

Shows:

• Everything in CONCEPTUAL
• Temperature and pressure
• Flow rates
• Equipment specifications
• Phase fractions

Hides:

• Full compositions
• Solver diagnostics

Use for: Engineering review, process design

DEBUG

public static final DiagramDetailLevel DEBUG

Debug level - maximum detail for troubleshooting.

Shows:

• Everything in ENGINEERING
• Full stream compositions
• Solver convergence info
• Calculation order
• Recycle loop indicators
• All internal streams

Use for: Debugging, solver troubleshooting

Field Details

showConditions

private final boolean showConditions

Whether to show process conditions (T, P).

showFlowRates

private final boolean showFlowRates

Whether to show flow rates.

showCompositions

private final boolean showCompositions

Whether to show stream compositions.

showSpecifications

private final boolean showSpecifications

Whether to show equipment specifications.

compactLabels

private final boolean compactLabels

Whether to use compact node labels.

Constructor Details

DiagramDetailLevel

private DiagramDetailLevel(boolean showConditions,
 boolean showFlowRates,
 boolean showCompositions,
 boolean showSpecifications,
 boolean compactLabels)

Constructor for DiagramDetailLevel.

Parameters:

showConditions - whether to show T, P conditions

showFlowRates - whether to show flow rates

showCompositions - whether to show compositions

showSpecifications - whether to show equipment specs

compactLabels - whether to use compact labels

Method Details

values

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

showConditions

public boolean showConditions()

Whether to show process conditions (temperature, pressure).

Returns:

true if conditions should be shown

showFlowRates

public boolean showFlowRates()

Whether to show flow rates.

Returns:

true if flow rates should be shown

showCompositions

public boolean showCompositions()

Whether to show stream compositions.

Returns:

true if compositions should be shown

showSpecifications

public boolean showSpecifications()

Whether to show equipment specifications.

Returns:

true if specifications should be shown

useCompactLabels

public boolean useCompactLabels()

Whether to use compact node labels.

Returns:

true if compact labels should be used