Class DesignResult.ConstraintStatus

java.lang.Object

neqsim.process.design.DesignResult.ConstraintStatus

Enclosing class:

DesignResult

public static class DesignResult.ConstraintStatus
extends Object

Status of a single constraint.

Version:

1.0

Author:

NeqSim Development Team

Field Summary

Fields

Modifier and Type	Field	Description
private double	currentValue
private double	limitValue
private String	name
private boolean	satisfied
private double	utilization

Constructor Summary

Constructors

Constructor	Description
ConstraintStatus(String name, double currentValue, double limitValue, double utilization, boolean satisfied)	Create constraint status.

Method Summary

Modifier and Type	Method	Description
double	getCurrentValue()	Get current value.
double	getLimitValue()	Get limit value.
String	getName()	Get constraint name.
double	getUtilization()	Get utilization (current/limit).
boolean	isSatisfied()	Check if constraint is satisfied.

Methods inherited from class Object

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

Field Details

name

private String name

currentValue

private double currentValue

limitValue

private double limitValue

utilization

private double utilization

satisfied

private boolean satisfied

Constructor Details

ConstraintStatus

public ConstraintStatus(String name,
 double currentValue,
 double limitValue,
 double utilization,
 boolean satisfied)

Create constraint status.

Parameters:

name - constraint name

currentValue - current value

limitValue - limit value

utilization - utilization (0-1)

satisfied - whether satisfied

Method Details

getName

public String getName()

Get constraint name.

Returns:

name

getCurrentValue

public double getCurrentValue()

Get current value.

Returns:

current value

getLimitValue

public double getLimitValue()

Get limit value.

Returns:

limit value

getUtilization

public double getUtilization()

Get utilization (current/limit).

Returns:

utilization fraction

isSatisfied

public boolean isSatisfied()

Check if constraint is satisfied.

Returns:

true if satisfied