Class BudgetConstraint

java.lang.Object

com.eqixiac.equinix.design.constraint.BudgetConstraint

All Implemented Interfaces:

Constraint

public final class BudgetConstraint
extends Object
implements Constraint

The expected monthly cost must not exceed commercial.budgetMaxMonthly. Compared in ONE currency only: when the priced lines are in another currency, or span several, the budget is reported as not evaluable and the design is not rejected; amounts are never converted or compared across currencies. When items are unpriced the priced part is a lower bound: a design is rejected only if that lower bound already exceeds the budget.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The id.

Constructor Summary

Constructors

Constructor	Description
BudgetConstraint()

Method Summary

Modifier and Type	Method	Description
ConstraintVerdict	check(MetroPortfolio portfolio, DesignContext context)	Checks a whole portfolio.
String	id()
boolean	usesCost()	Whether Constraint.check(MetroPortfolio, DesignContext) prices the portfolio through DesignContext.costModel().

Methods inherited from class Object

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

Methods inherited from interface Constraint

admits

Modifier and Type	Method	Description
default boolean	admits(MetroFacts metro, DesignContext context)	Cheap per-metro pruning before portfolios are formed.

Field Details

ID

public static final String ID

The id.

See Also:

• Constant Field Values

Constructor Details

BudgetConstraint

public BudgetConstraint()

Method Details

id

public String id()

Specified by:

id in interface Constraint

Returns:

a stable id, lower_snake_case (for example max_latency)

usesCost

public boolean usesCost()

Description copied from interface: Constraint

Whether Constraint.check(MetroPortfolio, DesignContext) prices the portfolio through DesignContext.costModel(). A solver uses it to price ahead, in one batch, the portfolios that reach a pricing constraint (CostModel.prepare(Collection, DesignContext)); the verdicts are the same either way. The default is false: a pricing constraint that says so is only slower, never wrong.

Specified by:

usesCost in interface Constraint

Returns:

true: the budget is checked against the priced portfolio

check

public ConstraintVerdict check(MetroPortfolio portfolio,
 DesignContext context)

Description copied from interface: Constraint

Checks a whole portfolio.

Specified by:

check in interface Constraint

Parameters:

portfolio - the candidate design

context - the facts of this run

Returns:

the verdict with its reason