edu.nrao.sss.model.project.scheduling.constraint
Class ConstraintApi

java.lang.Object
  edu.nrao.sss.model.project.scheduling.constraint.Constraint
      edu.nrao.sss.model.project.scheduling.constraint.ConstraintApi

public class ConstraintApi
extends Constraint

Represents an atmospheric phase interference weather constraint.

Author:

slovelan

Field Summary

protected double

phase

Fields inherited from class edu.nrao.sss.model.project.scheduling.constraint.Constraint

constraintType

Constructor Summary

ConstraintApi()

ConstraintApi(ConstraintApi theCopy)
Copy constructor in lieu of the troublesome clone.

ConstraintApi(double amount)

Method Summary

String	getDisplayName()
double	getPhase()
ConstraintProbability	getProbabilitySuccess(List<Constraint> constraints) Returns a ConstraintProbability indicating the probability of success of the scheduling block with respect to this requirement.
Object	getValue()
boolean	isSpecified() Returns true if this constraint represents a restriction in terms of scheduling on the block; false otherwise.
void	reset() Resets this constraint back to its original default (unspecified value).
void	setPhase(double phase)

Methods inherited from class edu.nrao.sss.model.project.scheduling.constraint.Constraint

equals, getConstraint, getConstraintType, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

phase

protected double phase

Constructor Detail

ConstraintApi

public ConstraintApi(double amount)

ConstraintApi

public ConstraintApi()

ConstraintApi

public ConstraintApi(ConstraintApi theCopy)

Copy constructor in lieu of the troublesome clone.

Method Detail

getDisplayName

public String getDisplayName()

isSpecified

public boolean isSpecified()

Description copied from class: Constraint

Returns true if this constraint represents a restriction in terms of scheduling on the block; false otherwise.

Specified by:

isSpecified in class Constraint

Returns:

true if this constraint is inot in its default state; false otherwise.

reset

public void reset()

Description copied from class: Constraint

Resets this constraint back to its original default (unspecified value).

Specified by:

reset in class Constraint

getPhase

public double getPhase()

setPhase

public void setPhase(double phase)

getValue

public Object getValue()

Specified by:

getValue in class Constraint

getProbabilitySuccess

public ConstraintProbability getProbabilitySuccess(List<Constraint> constraints)

Description copied from class: Constraint

Returns a ConstraintProbability indicating the probability of success of the scheduling block with respect to this requirement.

Specified by:

getProbabilitySuccess in class Constraint

Parameters:

constraints - the current external operating condition the could be the current wind speed if the constraint represents wind speed or a date if the constraint represents a position elevation.

Returns:

a ConstraintProbability indicating the probability of successful completion of this scheduling block under the current operating conditions.