org.metacsp.time

Class TimePoint

java.lang.Object

org.metacsp.framework.Variable

org.metacsp.time.TimePoint

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Variable>

public final class TimePoint
extends Variable

This class provides the building block of the APSPSolver temporal reasoner, namely time points. Note that as all variables, TimePoints should be created with a solver factory method (in this case, APSPSolver).

See Also:

Serialized Form

Field Summary

Fields inherited from class org.metacsp.framework.Variable

attributes, backupForSerialization, dependentVariables, id, logger, solver

Constructor Summary

Constructors

Constructor and Description
TimePoint(int id, int MAX_TPS, APSPSolver sol) Instantiate a new TimePoint with a given identifier and maximum number of time points that can be added to the temporal network.
TimePoint(int id, int MAX_TPS, APSPSolver sol, long lb, long ub) Instantiate a new TimePoint with a given identifier, upper bound and lower bound that can be added to the temporal network.

Method Summary

Modifier and Type	Method and Description
TimePoint	clone()
int	compareTo(Variable o)
boolean	equals(java.lang.Object obj) Compare this time point with a reference time point.
Domain	getDomain() Get the domain of this Variable.
long	getLowerBound() Get this time point's lower bound.
SimpleDistanceConstraint[]	getOut()
SimpleDistanceConstraint	getOut(int i) Get the i-th outgoing edge of this time point.
long	getUpperBound() Get this time point's upper bound.
boolean	isUsed() Reports whether this time point is used in the underlying temporal network.
void	setDomain(Domain d) Set the domain of this variable.
void	setLowerBound(long newVal) Set this time point's lower bound.
void	setOut(int i, SimpleDistanceConstraint newVal) Set the i-th outgoing edge of this time point.
void	setUpperBound(long newVal) Set this time point's upper bound.
void	setUsed(boolean newVal) Set whether this time point as used in the underlying temporal network.
java.lang.String	toString() Get a String representation of this TimePoint.

Methods inherited from class org.metacsp.framework.Variable

addDependentVariables, dependsOn, getAncestorVariable, getAttributes, getColor, getComponent, getConstraintSolver, getDependentVariables, getDescription, getID, getMarking, getOwner, getParentVariable, getRecursivelyDependentVariables, getRootVariable, hashCode, isDependentVariable, removeDependentVariables, setAttributes, setColor, setComponent, setDependentVariables, setMarking, setOwner, setParentVariable

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimePoint

public TimePoint(int id,
                 int MAX_TPS,
                 APSPSolver sol)

Instantiate a new TimePoint with a given identifier and maximum number of time points that can be added to the temporal network. This constructor should NOT be used. As the APSPSolver is static, this method is used in the APSPSolver's constructor to instantiate the array of time points representing the temporal network.

Parameters:

id - The identifier of this time point.

MAX_TPS - The maximum number of time points supported by the APSPSolver.

sol - the APSPSolver managing this TimePoint.

TimePoint

public TimePoint(int id,
                 int MAX_TPS,
                 APSPSolver sol,
                 long lb,
                 long ub)

Instantiate a new TimePoint with a given identifier, upper bound and lower bound that can be added to the temporal network. This constructor should NOT be used (it is used within the APSPSolver, a static STN implementation.

Parameters:

id - The identifier of this time point.

lb - The lower bound of this time point.

ub - The upper bound of this time point.

sol - the APSPSolver managing this TimePoint.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compare this time point with a reference time point.

Overrides:

equals in class Variable

Returns:

True iff the two time points have the same identifier.

toString

public java.lang.String toString()

Get a String representation of this TimePoint.

Specified by:

toString in class Variable

Returns:

A String describing this TimePoint.

getLowerBound

public long getLowerBound()

Get this time point's lower bound.

Returns:

This time point's lower bound.

setLowerBound

public void setLowerBound(long newVal)

Set this time point's lower bound.

Parameters:

newVal - The new lower bound to set.

getUpperBound

public long getUpperBound()

Get this time point's upper bound.

Returns:

This time point's upper bound.

setUpperBound

public void setUpperBound(long newVal)

Set this time point's upper bound.

Parameters:

newVal - The new upper bound to set.

isUsed

public boolean isUsed()

Reports whether this time point is used in the underlying temporal network.

Returns:

True iff this time point is used in the underlying temporal netowrk.

setUsed

public void setUsed(boolean newVal)

Set whether this time point as used in the underlying temporal network.

Parameters:

newVal - Set to true iff the time point should be included in the underlying temporal network.

getOut

public SimpleDistanceConstraint getOut(int i)

Get the i-th outgoing edge of this time point.

Parameters:

i - The index of the edge to get.

Returns:

The SimpleDistanceConstraint correspionding to the i-th outgoing edge.

getOut

public SimpleDistanceConstraint[] getOut()

setOut

public void setOut(int i,
                   SimpleDistanceConstraint newVal)

Set the i-th outgoing edge of this time point.

Parameters:

i - The index of the edge to set.

newVal - The SimpleDistanceConstraint correspionding to set as i-th outgoing edge.

getDomain

public Domain getDomain()

Description copied from class: Variable

Get the domain of this Variable. Must be implemented by the ConstraintSolver developer, since getting the domain of a variable may be a non-trivial operation.

Specified by:

getDomain in class Variable

Returns:

The domain of the variable.

setDomain

public void setDomain(Domain d)

Description copied from class: Variable

Set the domain of this variable. Must be implemented by the ConstraintSolver developer, since setting the domain of a variable may be a non-trivial operation.

Specified by:

setDomain in class Variable

Parameters:

d - The domain of the variable.

compareTo

public int compareTo(Variable o)

clone

public TimePoint clone()

Overrides:

clone in class java.lang.Object