stella
Interface Appointable.Constraint<T>

All Known Implementing Classes:

AbstractTarget.ConstraintAdapter, ParsedTarget.Constraint, PointingScheduler.HeightConstraint, PointingScheduler.SolarConstraint

Enclosing interface:

Appointable

public static interface Appointable.Constraint<T>

A constraint imposed on all targets.

Method Summary

T	getAbove() Returns the upper bound of the forbidden parameter space.
T	getBelow() Returns the lower bound of the forbidden parameter space.
T	getFrom() Returns the lower bound of the allowed parameter space.
T	getMax() Returns the maximum of the allowed parameter space.
T	getMin() Returns the minimum of the allowed parameter space.
long	getTimeForConstraint(ParameterClustering set, TargetDefinition target) Returns the remaining observing time for the target under the given observing conditions.
T	getTo() Returns the upper bound of the allowed parameter space.
String	getValueName() The Value we act on.
boolean	isSatisfied(ParameterClustering set, TargetDefinition target) Returns true, if a target can be observed under current observing conditions considering the specific constraint.
boolean	isSatisfied(ParameterClustering set, TargetDefinition target, double tolerance) Returns true, if a target can be observed under current observing conditions considering the specific constraint.

Method Detail

getValueName

String getValueName()

The Value we act on.

getMin

T getMin()

Returns the minimum of the allowed parameter space. If the contraint is no minimum-constraint, this returns null.

getMax

T getMax()

Returns the maximum of the allowed parameter space. If the contraint is no maximum-constraint, this returns null.

getFrom

T getFrom()

Returns the lower bound of the allowed parameter space. If the constraint is no from-to-constraint, this returns null.

getTo

T getTo()

Returns the upper bound of the allowed parameter space. If the constraint is no from-to-constraint, this returns null.

getBelow

T getBelow()

Returns the lower bound of the forbidden parameter space. If the constraint is no below-above-constraint, this returns null.

getAbove

T getAbove()

Returns the upper bound of the forbidden parameter space. If the constraint is no below-above-constraint, this returns null.

isSatisfied

boolean isSatisfied(ParameterClustering set,
                    TargetDefinition target)

Returns true, if a target can be observed under current observing conditions considering the specific constraint.

isSatisfied

boolean isSatisfied(ParameterClustering set,
                    TargetDefinition target,
                    double tolerance)

Returns true, if a target can be observed under current observing conditions considering the specific constraint. A tolerance factor is introduced for mindless users that request out-of-bounds values of S/N.

getTimeForConstraint

long getTimeForConstraint(ParameterClustering set,
                          TargetDefinition target)

Returns the remaining observing time for the target under the given observing conditions. This is more specific then the isSatisfied(stella.ParameterClustering, stella.TargetDefinition) method, as it also gives a time. Targets that return a value of zero here must also return false in the method isSatisfied(stella.ParameterClustering, stella.TargetDefinition).