org.btrplace.btrpsl.constraint

Interface ConstraintParam<E>

All Known Implementing Classes:

DefaultConstraintParam, ListOfParam, NumberParam, OneOfParam, StringParam

public interface ConstraintParam<E>

A parameter for a constraint.

Author:

Fabien Hermenier

Method Summary

Modifier and Type	Method and Description
String	fullSignature() Get the signature of the parameter including the parameter name.
String	getName() Get the parameter name.
boolean	isCompatibleWith(BtrPlaceTree t, BtrpOperand o) Check if a given operand is compatible with this parameter.
String	prettySignature() Get the signature of the parameter without the parameter name.
E	transform(SatConstraintBuilder cb, BtrPlaceTree tree, BtrpOperand op) Transform an operand into the right btrplace parameter.

Method Detail

prettySignature

String prettySignature()

Get the signature of the parameter without the parameter name.

Returns:

a non-empty string

fullSignature

String fullSignature()

Get the signature of the parameter including the parameter name.

Returns:

a non-empty string

transform

E transform(SatConstraintBuilder cb,
            BtrPlaceTree tree,
            BtrpOperand op)

Transform an operand into the right btrplace parameter.

Parameters:

cb - the associated constraint

tree - the tree use to propagate errors

op - the operand to transform

Returns:

the transformed parameter. null if the transformation is not possible

isCompatibleWith

boolean isCompatibleWith(BtrPlaceTree t,
                         BtrpOperand o)

Check if a given operand is compatible with this parameter.

Parameters:

t - the tree used to propagate errors

o - the operand to test

Returns:

true iff the operand is compatible

getName

String getName()

Get the parameter name.

Returns:

a non-empty string