org.metacsp.meta.simplePlanner

Class SimpleDomain

java.lang.Object

org.metacsp.framework.Constraint

org.metacsp.framework.meta.MetaConstraint

org.metacsp.meta.simplePlanner.SimpleDomain

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FluentBasedSimpleDomain, ProactivePlanningDomain

public class SimpleDomain
extends MetaConstraint

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleDomain.markings

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<java.lang.String>	actuators
protected java.util.Vector<java.lang.String>	contextVars
protected java.util.HashMap<SimpleReusableResource,java.util.HashMap<Variable,java.lang.Integer>>	currentResourceUtilizers
protected long	filteringTime
protected java.util.Vector<SimpleOperator>	operators
protected java.util.HashMap<SimpleOperator,java.lang.Integer>	operatorsLevels
protected java.lang.String[]	resourceNames
protected java.util.HashMap<java.lang.String,SimpleReusableResource>	resourcesMap
protected java.util.Vector<java.lang.String>	sensors
java.util.HashMap<SymbolicVariableActivity,SymbolicVariableActivity>	unificationTrack

Fields inherited from class org.metacsp.framework.meta.MetaConstraint

independentMC, metaCS, valOH, varOH

Fields inherited from class org.metacsp.framework.Constraint

annotation, autoRemovable, color, id, logger, masked, numIDs, scope

Constructor Summary

Constructors

Modifier	Constructor and Description
	SimpleDomain(int[] capacities, java.lang.String[] resourceNames, java.lang.String domainName)
protected	SimpleDomain(int[] capacities, java.lang.String[] resourceNames, java.lang.String domainName, java.lang.String everything)

Method Summary

Modifier and Type	Method and Description
void	addActuator(java.lang.String actuator)
void	addContextVar(java.lang.String cv)
void	addOperator(SimpleOperator r)
void	addResourceMap(java.lang.String resourcename, SimpleReusableResource simpleReusableResource)
void	addResourceUtilizer(SimpleReusableResource rr, Variable var, java.lang.Integer amount)
void	addResourceUtilizers(SimpleReusableResource rr, java.util.HashMap<Variable,java.lang.Integer> hm)
void	addSensor(java.lang.String sensor)
java.lang.Object	clone()
void	draw(ConstraintNetwork network) Method to draw the metaCSP's constraint network according to the rationale of this MetaConstraint (e.g., for a resource, this could be the resource usage profile as it is determined by the given constraint network).
protected ConstraintNetwork	expandOperator(SimpleOperator possibleOperator, SymbolicVariableActivity problematicActivity)
java.lang.String[]	getActuators()
java.util.HashMap<SimpleReusableResource,java.util.HashMap<Variable,java.lang.Integer>>	getAllResourceUsageLevel()
java.lang.String[]	getContextVars()
SimpleReusableResource[]	getCurrentReusableResourcesUsedByActivity(Variable act)
java.lang.String	getEdgeLabel() Every Constraint should implement this method - its value is what is drawn by the ConstraintNetwork rendering methods.
ConstraintSolver	getGroundSolver() Provides the definition of how to get the/a groundSolver for this MetaConstraint.
ConstraintNetwork[]	getMetaValues(MetaVariable metaVariable) Get all meta values for a given MetaVariable.
ConstraintNetwork[]	getMetaVariables() Get all MetaVariables according to this MetaConstraint.
SimpleOperator[]	getOperators()
java.util.HashMap<java.lang.String,SimpleReusableResource>	getResources()
int	getResourceUsageLevel(SimpleReusableResource rr, Variable act)
Schedulable[]	getSchedulingMetaConstraints()
java.lang.String[]	getSensors()
java.lang.String[]	getTimelines()
protected ConstraintNetwork[]	getUnifications(SymbolicVariableActivity activity)
java.util.HashMap<SymbolicVariableActivity,SymbolicVariableActivity>	getUnificationTrack()
static java.lang.String	instantiateVariable(java.lang.String var)
boolean	isActuator(java.lang.String component)
boolean	isContextVar(java.lang.String component)
boolean	isEquivalent(Constraint c) Method for assessing the "equivalence" between two constraints.
boolean	isSensor(java.lang.String component)
void	markResolvedSub(MetaVariable con, ConstraintNetwork metaValue) Method to mark a MetaVariable as solved.
static SimpleDomain	parseDomain(MetaConstraintSolver sp, java.lang.String filename, java.lang.Class<?> domainType) Parses a domain file (see domains/testDomain.ddl for an example), instantiates the necessary MetaConstraints and adds them to the provided SimplePlanner.
protected static java.lang.String[]	parseKeyword(java.lang.String keyword, java.lang.String everything)
java.lang.String[]	parseUserKeyword(java.lang.String keyword) Parse a user-defined keyword in the domain, in the form (UserKeyword value1 [value2 ...
protected static java.util.HashMap<java.lang.String,java.lang.Integer>	processResources(java.lang.String[] resources)
void	resetAllResourceAllocation()
void	setFileteringTime(long filteringTime)
java.lang.String	toString() Every Constraint should implement a toString method (used by the ConstraintNetwork rendering methods).

Methods inherited from class org.metacsp.framework.meta.MetaConstraint

getDescription, getMetaValue, getMetaVariable, getValOH, getVarOH, setMetaSolver, setValOH, setVarOH

Methods inherited from class org.metacsp.framework.Constraint

getAnnotation, getColor, getID, getScope, isAutoRemovable, isMasked, isSkippableSolver, isUnary, mask, setAnnotation, setAutoRemovable, setColor, setScope, skipSolver, unmask

Methods inherited from class java.lang.Object

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

Field Detail

operators

protected java.util.Vector<SimpleOperator> operators

resourceNames

protected java.lang.String[] resourceNames

resourcesMap

protected java.util.HashMap<java.lang.String,SimpleReusableResource> resourcesMap

currentResourceUtilizers

protected java.util.HashMap<SimpleReusableResource,java.util.HashMap<Variable,java.lang.Integer>> currentResourceUtilizers

filteringTime

protected long filteringTime

sensors

protected java.util.Vector<java.lang.String> sensors

actuators

protected java.util.Vector<java.lang.String> actuators

contextVars

protected java.util.Vector<java.lang.String> contextVars

operatorsLevels

protected java.util.HashMap<SimpleOperator,java.lang.Integer> operatorsLevels

unificationTrack

public java.util.HashMap<SymbolicVariableActivity,SymbolicVariableActivity> unificationTrack

Constructor Detail

SimpleDomain

public SimpleDomain(int[] capacities,
                    java.lang.String[] resourceNames,
                    java.lang.String domainName)

SimpleDomain

protected SimpleDomain(int[] capacities,
                       java.lang.String[] resourceNames,
                       java.lang.String domainName,
                       java.lang.String everything)

Method Detail

getTimelines

public java.lang.String[] getTimelines()

getSchedulingMetaConstraints

public Schedulable[] getSchedulingMetaConstraints()

getUnificationTrack

public java.util.HashMap<SymbolicVariableActivity,SymbolicVariableActivity> getUnificationTrack()

setFileteringTime

public void setFileteringTime(long filteringTime)

addResourceUtilizers

public void addResourceUtilizers(SimpleReusableResource rr,
                                 java.util.HashMap<Variable,java.lang.Integer> hm)

addResourceUtilizer

public void addResourceUtilizer(SimpleReusableResource rr,
                                Variable var,
                                java.lang.Integer amount)

addResourceMap

public void addResourceMap(java.lang.String resourcename,
                           SimpleReusableResource simpleReusableResource)

addOperator

public void addOperator(SimpleOperator r)

getOperators

public SimpleOperator[] getOperators()

getGroundSolver

public ConstraintSolver getGroundSolver()

Description copied from class: MetaConstraint

Provides the definition of how to get the/a groundSolver for this MetaConstraint.

Specified by:

getGroundSolver in class MetaConstraint

Returns:

The/a groundSolver for this MetaConstraint.

getMetaVariables

public ConstraintNetwork[] getMetaVariables()

Description copied from class: MetaConstraint

Get all MetaVariables according to this MetaConstraint. This method must be implemented by the designer of the implementing MetaConstraint class.

Specified by:

getMetaVariables in class MetaConstraint

Returns:

All MetaVariables according to this MetaConstraint.

expandOperator

protected ConstraintNetwork expandOperator(SimpleOperator possibleOperator,
                                           SymbolicVariableActivity problematicActivity)

addSensor

public void addSensor(java.lang.String sensor)

getSensors

public java.lang.String[] getSensors()

addActuator

public void addActuator(java.lang.String actuator)

getActuators

public java.lang.String[] getActuators()

addContextVar

public void addContextVar(java.lang.String cv)

getContextVars

public java.lang.String[] getContextVars()

isSensor

public boolean isSensor(java.lang.String component)

isActuator

public boolean isActuator(java.lang.String component)

isContextVar

public boolean isContextVar(java.lang.String component)

getUnifications

protected ConstraintNetwork[] getUnifications(SymbolicVariableActivity activity)

getMetaValues

public ConstraintNetwork[] getMetaValues(MetaVariable metaVariable)

Description copied from class: MetaConstraint

Get all meta values for a given MetaVariable. This method must be implemented in the specific MetaConstraint.

Specified by:

getMetaValues in class MetaConstraint

Parameters:

metaVariable - The MetaVariable for which we seek meta values.

Returns:

All meta values for the given MetaVariable.

markResolvedSub

public void markResolvedSub(MetaVariable con,
                            ConstraintNetwork metaValue)

Description copied from class: MetaConstraint

Method to mark a MetaVariable as solved. This method is called by the MetaConstraintSolver and must be implemented by the developer of the MetaConstraint.

Specified by:

markResolvedSub in class MetaConstraint

Parameters:

con - The MetaVariable that is to be considered solved by the given meta value.

metaValue - The solving meta value.

draw

public void draw(ConstraintNetwork network)

Description copied from class: MetaConstraint

Method to draw the metaCSP's constraint network according to the rationale of this MetaConstraint (e.g., for a resource, this could be the resource usage profile as it is determined by the given constraint network). This method must be implemented by the developer of the MetaConstraint.

Specified by:

draw in class MetaConstraint

Parameters:

network - The constraint network to draw.

getResources

public java.util.HashMap<java.lang.String,SimpleReusableResource> getResources()

getCurrentReusableResourcesUsedByActivity

public SimpleReusableResource[] getCurrentReusableResourcesUsedByActivity(Variable act)

getResourceUsageLevel

public int getResourceUsageLevel(SimpleReusableResource rr,
                                 Variable act)

getAllResourceUsageLevel

public java.util.HashMap<SimpleReusableResource,java.util.HashMap<Variable,java.lang.Integer>> getAllResourceUsageLevel()

resetAllResourceAllocation

public void resetAllResourceAllocation()

toString

public java.lang.String toString()

Description copied from class: Constraint

Every Constraint should implement a toString method (used by the ConstraintNetwork rendering methods).

Specified by:

toString in class Constraint

Returns:

the String representation of this Constraint.

getEdgeLabel

public java.lang.String getEdgeLabel()

Description copied from class: Constraint

Every Constraint should implement this method - its value is what is drawn by the ConstraintNetwork rendering methods.

Specified by:

getEdgeLabel in class Constraint

Returns:

a String representation of the constraint to be used for ConstraintNetwork rendering.

clone

public java.lang.Object clone()

Specified by:

clone in class Constraint

isEquivalent

public boolean isEquivalent(Constraint c)

Description copied from class: Constraint

Method for assessing the "equivalence" between two constraints. This is not used for lookups nor comparisons (hence, it is not the equals method).

Specified by:

isEquivalent in class Constraint

Parameters:

c - The Constraint to compare against.

Returns:

true iff the two constraints are considered to be equivalent.

instantiateVariable

public static java.lang.String instantiateVariable(java.lang.String var)

parseKeyword

protected static java.lang.String[] parseKeyword(java.lang.String keyword,
                                                 java.lang.String everything)

processResources

protected static java.util.HashMap<java.lang.String,java.lang.Integer> processResources(java.lang.String[] resources)

parseUserKeyword

public java.lang.String[] parseUserKeyword(java.lang.String keyword)

Parse a user-defined keyword in the domain, in the form (UserKeyword value1 [value2 ... valueN])

Parameters:

keyword - The keyword to parse, i.e., UserKeyword

Returns:

An array of value lists, one for each element with the user keyword, e.g., ["value11 value12", "value21 value22 value23", "value31", ...]

parseDomain

public static SimpleDomain parseDomain(MetaConstraintSolver sp,
                                       java.lang.String filename,
                                       java.lang.Class<?> domainType)

Parses a domain file (see domains/testDomain.ddl for an example), instantiates the necessary MetaConstraints and adds them to the provided SimplePlanner.

Parameters:

sp - The SimplePlanner that will use this domain.

filename - Text file containing the domain definition.