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

java.lang.Object
  extended by edu.nrao.sss.model.project.scheduling.constraint.Constraint
      extended by edu.nrao.sss.model.project.scheduling.constraint.ConstraintPositionElevation

public class ConstraintPositionElevation
extends Constraint

Represents a minimum elevation of the target constraint.

Author:
slovelan

Field Summary
 
Fields inherited from class edu.nrao.sss.model.project.scheduling.constraint.Constraint
constraintType
 
Constructor Summary
ConstraintPositionElevation()
           
ConstraintPositionElevation(ConstraintPositionElevation cpe)
           
 
Method Summary
 float getElevation()
           
 ConstraintProbability getProbabilitySuccess(List<Constraint> constraints)
          Returns the sign of the elevation of the target as the probability of success of the scheduling block or returns 0 if the elevation does not meet the minimum requirement in this constraint.
 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 setElevation(float elevation)
           
 
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
 

Constructor Detail

ConstraintPositionElevation

public ConstraintPositionElevation()

ConstraintPositionElevation

public ConstraintPositionElevation(ConstraintPositionElevation cpe)
Method Detail

getValue

public Object getValue()
Specified by:
getValue in class Constraint

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

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.

getElevation

public float getElevation()

setElevation

public void setElevation(float elevation)

getProbabilitySuccess

public ConstraintProbability getProbabilitySuccess(List<Constraint> constraints)
Returns the sign of the elevation of the target as the probability of success of the scheduling block or returns 0 if the elevation does not meet the minimum requirement in this constraint.

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 success for the constraint.


Copyright © 2009. All Rights Reserved.