org.btrplace.btrpsl.constraint

Class ListOfParam

java.lang.Object

org.btrplace.btrpsl.constraint.DefaultConstraintParam<List<Object>>

org.btrplace.btrpsl.constraint.ListOfParam

All Implemented Interfaces:

ConstraintParam<List<Object>>

public class ListOfParam
extends DefaultConstraintParam<List<Object>>

A parameter for a constraint that denotes a set of elements.

Author:

Fabien Hermenier

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canBeEmpty
protected int	depth
protected BtrpOperand.Type	type

Constructor Summary

Constructors

Constructor and Description
ListOfParam(String n, BtrpOperand.Type t) Make a new parameter for a simple set, possibly empty, of elements.
ListOfParam(String n, int d, BtrpOperand.Type t, boolean e) Make a new set parameter

Method Summary

Modifier and Type	Method and Description
String	fullSignature() Get the signature of the parameter including 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.
List<Object>	transform(SatConstraintBuilder cb, BtrPlaceTree tree, BtrpOperand op) Transform an operand into the right btrplace parameter.

Methods inherited from class org.btrplace.btrpsl.constraint.DefaultConstraintParam

getName

Methods inherited from class java.lang.Object

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

Field Detail

canBeEmpty

protected boolean canBeEmpty

type

protected BtrpOperand.Type type

depth

protected int depth

Constructor Detail

ListOfParam

public ListOfParam(String n,
                   BtrpOperand.Type t)

Make a new parameter for a simple set, possibly empty, of elements.

Parameters:

n - the parameter name

t - the type of the element inside the set

ListOfParam

public ListOfParam(String n,
                   int d,
                   BtrpOperand.Type t,
                   boolean e)

Make a new set parameter

Parameters:

n - the parameter name

d - the set depth

t - the type of the elements inside the set

e - true to allow empty sets.

Method Detail

prettySignature

public String prettySignature()

Description copied from interface: ConstraintParam

Get the signature of the parameter without the parameter name.

Specified by:

prettySignature in interface ConstraintParam<List<Object>>

Overrides:

prettySignature in class DefaultConstraintParam<List<Object>>

Returns:

a non-empty string

fullSignature

public String fullSignature()

Description copied from interface: ConstraintParam

Get the signature of the parameter including the parameter name.

Specified by:

fullSignature in interface ConstraintParam<List<Object>>

Overrides:

fullSignature in class DefaultConstraintParam<List<Object>>

Returns:

a non-empty string

transform

public List<Object> transform(SatConstraintBuilder cb,
                              BtrPlaceTree tree,
                              BtrpOperand op)

Description copied from interface: ConstraintParam

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

public boolean isCompatibleWith(BtrPlaceTree t,
                                BtrpOperand o)

Description copied from interface: ConstraintParam

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