Class TieInCapacityPlanner.ProcessOutcome

java.lang.Object

neqsim.process.fielddevelopment.tieback.capacity.TieInCapacityPlanner.ProcessOutcome

Enclosing class:

TieInCapacityPlanner

private static final class TieInCapacityPlanner.ProcessOutcome
extends Object

Process-model capacity outcome.

Version:

1.0

Author:

ESOL

Field Summary

Fields

Modifier and Type	Field	Description
private final String	bottleneckName	Bottleneck equipment or diagnostic name.
private final double	bottleneckUtilization	Bottleneck utilization as a fraction.
private final boolean	capacityAvailable	True if process capacity is available.
private final boolean	processModelUsed	True if a process model was used.
private final Map<String,Double>	utilizationSummary	Equipment utilization summary in percent.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ProcessOutcome(boolean processModelUsed, boolean capacityAvailable, String bottleneckName, double bottleneckUtilization, Map<String,Double> utilizationSummary)	Creates a process-model outcome.

Method Summary

Modifier and Type	Method	Description
private static TieInCapacityPlanner.ProcessOutcome	failed(String message)	Creates a failed process outcome.
private static TieInCapacityPlanner.ProcessOutcome	notUsed()	Creates an outcome for cases where no process model is configured.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

processModelUsed

private final boolean processModelUsed

True if a process model was used.

capacityAvailable

private final boolean capacityAvailable

True if process capacity is available.

bottleneckName

private final String bottleneckName

Bottleneck equipment or diagnostic name.

bottleneckUtilization

private final double bottleneckUtilization

Bottleneck utilization as a fraction.

utilizationSummary

private final Map<String,Double> utilizationSummary

Equipment utilization summary in percent.

Constructor Details

ProcessOutcome

private ProcessOutcome(boolean processModelUsed,
 boolean capacityAvailable,
 String bottleneckName,
 double bottleneckUtilization,
 Map<String,Double> utilizationSummary)

Creates a process-model outcome.

Parameters:

processModelUsed - true if a process model was used

capacityAvailable - true if process capacity is available

bottleneckName - bottleneck name

bottleneckUtilization - bottleneck utilization fraction

utilizationSummary - utilization summary in percent

Method Details

notUsed

private static TieInCapacityPlanner.ProcessOutcome notUsed()

Creates an outcome for cases where no process model is configured.

Returns:

process outcome marked as not used

failed

private static TieInCapacityPlanner.ProcessOutcome failed(String message)

Creates a failed process outcome.

Parameters:

message - diagnostic message

Returns:

failed process outcome