Class FlowRateOptimizationResult.ConstraintViolation

java.lang.Object

neqsim.process.util.optimizer.FlowRateOptimizationResult.ConstraintViolation

All Implemented Interfaces:

Serializable

Enclosing class:

FlowRateOptimizationResult

public static class FlowRateOptimizationResult.ConstraintViolation
extends Object
implements Serializable

Details of a constraint violation.

Version:

1.0

Author:

ESOL

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final String	constraintName
private final double	currentValue
private final String	equipmentName
private final boolean	isHardViolation
private final double	limitValue
private static final long	serialVersionUID
private final String	unit

Constructor Summary

Constructors

Constructor	Description
ConstraintViolation(String constraintName, String equipmentName, double currentValue, double limitValue, String unit, boolean isHardViolation)	Creates a new constraint violation record.

Method Summary

Modifier and Type	Method	Description
String	getConstraintName()	Gets the constraint name.
double	getCurrentValue()	Gets the current value.
String	getEquipmentName()	Gets the equipment name.
double	getLimitValue()	Gets the limit value.
String	getUnit()	Gets the unit.
boolean	isHardViolation()	Checks if this is a hard constraint violation.
String	toString()

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

constraintName

private final String constraintName

equipmentName

private final String equipmentName

currentValue

private final double currentValue

limitValue

private final double limitValue

unit

private final String unit

isHardViolation

private final boolean isHardViolation

Constructor Details

ConstraintViolation

public ConstraintViolation(String constraintName,
 String equipmentName,
 double currentValue,
 double limitValue,
 String unit,
 boolean isHardViolation)

Creates a new constraint violation record.

Parameters:

constraintName - name of the violated constraint

equipmentName - name of the equipment with the violation

currentValue - current value of the constrained variable

limitValue - limit value that was exceeded

unit - unit of measurement

isHardViolation - true if this is a hard constraint violation

Method Details

getConstraintName

public String getConstraintName()

Gets the constraint name.

Returns:

constraint name

getEquipmentName

public String getEquipmentName()

Gets the equipment name.

Returns:

equipment name

getCurrentValue

public double getCurrentValue()

Gets the current value.

Returns:

current value

getLimitValue

public double getLimitValue()

Gets the limit value.

Returns:

limit value

getUnit

public String getUnit()

Gets the unit.

Returns:

unit

isHardViolation

public boolean isHardViolation()

Checks if this is a hard constraint violation.

Returns:

true if hard violation

toString

public String toString()

Overrides:

toString in class Object