Class PredictionResult.ConstraintViolation

java.lang.Object

neqsim.process.advisory.PredictionResult.ConstraintViolation

All Implemented Interfaces:

Serializable

Enclosing class:

PredictionResult

public static class PredictionResult.ConstraintViolation
extends Object
implements Serializable

A predicted constraint violation.

Version:

1.0

Author:

ESOL

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PredictionResult.ConstraintViolation.Severity	Severity levels for violations.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	constraintName
private final double	limitValue
private final double	predictedValue
private static final long	serialVersionUID
private final PredictionResult.ConstraintViolation.Severity	severity
private String	suggestedAction
private final Duration	timeToViolation
private final String	unit
private final String	variableName

Constructor Summary

Constructors

Constructor	Description
ConstraintViolation(String constraintName, String variableName, double predictedValue, double limitValue, String unit, Duration timeToViolation, PredictionResult.ConstraintViolation.Severity severity)	Creates a constraint violation prediction.

Method Summary

Modifier and Type	Method	Description
private String	formatDurationShort(Duration d)
String	getConstraintName()
String	getDescription()	Gets a human-readable description of the violation.
double	getLimitValue()
double	getPredictedValue()
PredictionResult.ConstraintViolation.Severity	getSeverity()
String	getSuggestedAction()
Duration	getTimeToViolation()
String	getUnit()
String	getVariableName()
void	setSuggestedAction(String action)

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

constraintName

private final String constraintName

variableName

private final String variableName

predictedValue

private final double predictedValue

limitValue

private final double limitValue

unit

private final String unit

timeToViolation

private final Duration timeToViolation

severity

private final PredictionResult.ConstraintViolation.Severity severity

suggestedAction

private String suggestedAction

Constructor Details

ConstraintViolation

public ConstraintViolation(String constraintName,
 String variableName,
 double predictedValue,
 double limitValue,
 String unit,
 Duration timeToViolation,
 PredictionResult.ConstraintViolation.Severity severity)

Creates a constraint violation prediction.

Parameters:

constraintName - name of the constraint

variableName - affected variable

predictedValue - predicted value at violation

limitValue - the limit being violated

unit - engineering unit

timeToViolation - time until violation expected

severity - severity level

Method Details

getDescription

public String getDescription()

Gets a human-readable description of the violation.

Returns:

description string

formatDurationShort

private String formatDurationShort(Duration d)

getConstraintName

public String getConstraintName()

getVariableName

public String getVariableName()

getPredictedValue

public double getPredictedValue()

getLimitValue

public double getLimitValue()

getUnit

public String getUnit()

getTimeToViolation

public Duration getTimeToViolation()

getSeverity

public PredictionResult.ConstraintViolation.Severity getSeverity()

getSuggestedAction

public String getSuggestedAction()

setSuggestedAction

public void setSuggestedAction(String action)