Class OptimizationResultBase.ConstraintViolation

java.lang.Object

neqsim.process.util.optimizer.OptimizationResultBase.ConstraintViolation

All Implemented Interfaces:

Serializable

Enclosing class:

OptimizationResultBase

public static class OptimizationResultBase.ConstraintViolation
extends Object
implements Serializable

Represents a constraint violation.

Version:

1.0

Author:

NeqSim Development Team

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ConstraintViolation()	Default constructor.
ConstraintViolation(String equipmentName, String constraintName, double currentValue, double limitValue, String unit, boolean isHardConstraint)	Constructor with all fields.

Method Summary

Modifier and Type	Method	Description
String	getConstraintName()
double	getCurrentValue()
String	getEquipmentName()
double	getLimitValue()
String	getUnit()
double	getViolationAmount()	Gets the violation amount (how much over the limit).
double	getViolationPercent()	Gets the violation as a percentage of the limit.
boolean	isHardConstraint()
void	setConstraintName(String constraintName)
void	setCurrentValue(double currentValue)
void	setEquipmentName(String equipmentName)
void	setHardConstraint(boolean hardConstraint)
void	setLimitValue(double limitValue)
void	setUnit(String unit)
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

equipmentName

private String equipmentName

constraintName

private String constraintName

currentValue

private double currentValue

limitValue

private double limitValue

unit

private String unit

isHardConstraint

private boolean isHardConstraint

Constructor Details

ConstraintViolation

public ConstraintViolation()

Default constructor.

ConstraintViolation

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

Constructor with all fields.

Parameters:

equipmentName - name of equipment

constraintName - name of constraint

currentValue - current value

limitValue - limit value

unit - unit of measurement

isHardConstraint - whether this is a hard constraint

Method Details

getEquipmentName

public String getEquipmentName()

setEquipmentName

public void setEquipmentName(String equipmentName)

getConstraintName

public String getConstraintName()

setConstraintName

public void setConstraintName(String constraintName)

getCurrentValue

public double getCurrentValue()

setCurrentValue

public void setCurrentValue(double currentValue)

getLimitValue

public double getLimitValue()

setLimitValue

public void setLimitValue(double limitValue)

getUnit

public String getUnit()

setUnit

public void setUnit(String unit)

isHardConstraint

public boolean isHardConstraint()

setHardConstraint

public void setHardConstraint(boolean hardConstraint)

getViolationAmount

public double getViolationAmount()

Gets the violation amount (how much over the limit).

Returns:

violation amount

getViolationPercent

public double getViolationPercent()

Gets the violation as a percentage of the limit.

Returns:

violation percentage

toString

public String toString()

Overrides:

toString in class Object