Class ConvergenceDiagnostics.DiagnosticReport

java.lang.Object

neqsim.process.equipment.util.ConvergenceDiagnostics.DiagnosticReport

All Implemented Interfaces:

Serializable

Enclosing class:

ConvergenceDiagnostics

public static class ConvergenceDiagnostics.DiagnosticReport
extends Object
implements Serializable

Complete diagnostic report for a process system.

Version:

1.0

Author:

Even Solbraa

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final List<ConvergenceDiagnostics.AdjusterStatus>	adjusterStatuses
private final boolean	allConverged
private final List<ConvergenceDiagnostics.RecycleStatus>	recycleStatuses
private static final long	serialVersionUID
private final List<String>	suggestions

Constructor Summary

Constructors

Constructor	Description
DiagnosticReport(boolean allConverged, List<ConvergenceDiagnostics.RecycleStatus> recycleStatuses, List<ConvergenceDiagnostics.AdjusterStatus> adjusterStatuses, List<String> suggestions)	Creates a diagnostic report.

Method Summary

Modifier and Type	Method	Description
List<ConvergenceDiagnostics.AdjusterStatus>	getAdjusterStatuses()	Gets the adjuster status list.
List<ConvergenceDiagnostics.RecycleStatus>	getRecycleStatuses()	Gets the recycle status list.
List<String>	getSuggestions()	Gets remediation suggestions for unconverged units.
boolean	isConverged()	Whether all recycle and adjuster units converged.
String	toJson()	Converts the report to JSON.

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

allConverged

private final boolean allConverged

recycleStatuses

private final List<ConvergenceDiagnostics.RecycleStatus> recycleStatuses

adjusterStatuses

private final List<ConvergenceDiagnostics.AdjusterStatus> adjusterStatuses

suggestions

private final List<String> suggestions

Constructor Details

DiagnosticReport

DiagnosticReport(boolean allConverged,
 List<ConvergenceDiagnostics.RecycleStatus> recycleStatuses,
 List<ConvergenceDiagnostics.AdjusterStatus> adjusterStatuses,
 List<String> suggestions)

Creates a diagnostic report.

Parameters:

allConverged - whether all recycles and adjusters converged

recycleStatuses - list of recycle statuses

adjusterStatuses - list of adjuster statuses

suggestions - list of remediation suggestions

Method Details

isConverged

public boolean isConverged()

Whether all recycle and adjuster units converged.

Returns:

true if all units converged

getSuggestions

public List<String> getSuggestions()

Gets remediation suggestions for unconverged units.

Returns:

list of human-readable suggestions

getRecycleStatuses

public List<ConvergenceDiagnostics.RecycleStatus> getRecycleStatuses()

Gets the recycle status list.

Returns:

list of recycle statuses

getAdjusterStatuses

public List<ConvergenceDiagnostics.AdjusterStatus> getAdjusterStatuses()

Gets the adjuster status list.

Returns:

list of adjuster statuses

toJson

public String toJson()

Converts the report to JSON.

Returns:

JSON representation of the diagnostic report