Appointable

All Superinterfaces:

Handable, TargetDefinition

All Known Implementing Classes:

GrbTarget, ParsedTarget
```
public interface Appointable
extends Handable
```
An interface describing an astronomical target that is aware of its current dispatch-scheduling properties. This includes methods to find out if a target is observable, how long it'll stay observable under unchanged weather conditions, and how long an observation under the current observing conditions may take.
Because targets that may be part of a sophisticated scheduling system, they must also support low-level handling properties. Therefore, this interface extends the Handable interface rather than the TargetDefinition.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Appointable.Constraint
A constraint imposed on all targets.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Appointable.Constraint` A constraint imposed on all targets.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double`	`getActualMerit(GlobalGrouping condition, Collection<Appointable> targets, long timespan)` Gets the value of the actual merit.
`Date`	`getDailyDate()` The date of the high daily merit.
`double`	`getDailyMerit()` The highest merit in the last 24 hours.
`Collection<Appointable>`	`getDaughters()` Returns a list of daugther targets.
`Date`	`getHighestDate()` The date of the highest merit.
`double`	`getHighestMerit()` The highest merit ever achieved.
`Appointable.Constraint`	`getLastFail()` The conditions which lately rendered this target unobservable
`double`	`getLastMerit()` The last measured merit.
`long`	`getObservingTime(GlobalGrouping condition)` Returns an estimate of the time required for an observation of this target.This is only an advisory method and will not return a very accurate estimate, but it should also work if the parameters handed over are invalid.
`long`	`getRemainingTime(GlobalGrouping condition)` Returns the time this target will remain observable under current weather conditions.
`boolean`	`isAbort(GlobalGrouping set)` Signals that the execution of this target should be aborted.
`boolean`	`isObservable(GlobalGrouping condition)` Checks if this target is currently observable.
`boolean`	`isProgramOver(GlobalGrouping set)` Test, if the observing program on the target is completed.
`boolean`	`isRetry(GlobalGrouping set)` Signals that the target should be retried immediately.

Methods inherited from interface stella.Handable
errorDaughter, errorMain, errorSuccessor, getPrecursor, getSuccessor, isEnabled, isFinished, isNotify, isPicked, setEnabled, setFinished, setPicked, setPrecursor

Methods inherited from interface target.TargetDefinition
getDescription, getDescriptionID, getEmailAddresses, getImageType, getInstitution, getName, getTargetResource, getTargetSpecific, getTeam, getTitle, getType, getUser

- Method Detail
  - getDaughters
```
Collection<Appointable> getDaughters()
```
    Returns a list of daugther targets. This list should have no multiple entries. If this target does not have any daugther targets, this method should return null.
  - isObservable
```
boolean isObservable(GlobalGrouping condition)
```
    Checks if this target is currently observable. This method is for the benefit of pre-selection. Targets that are not observable are not considered for dispatch-scheduling.
    
    Parameters:
    
    condition - A set of actual observing conditions
    
    Returns:
    
    True if the target is currently observable.
  - getActualMerit
```
double getActualMerit(GlobalGrouping condition,
                      Collection<Appointable> targets,
                      long timespan)
```
    Gets the value of the actual merit. The merit is used for scheduling. The merit is a number the higher the higher the current priority. Normally, the merit is calculated in accordance with the current observing conditions which are reflected in the parameter set handed over to this method. Note that the target assumes that all parameters are actual.
    The actual merit should be calculated in a way that it returns the maximum the merit will achieve in the projected observation period supplied to this method in the last parameter. Non time-depending targets may ignore this parameter. If the time span is zero, the observing time as returned by getObservingTime(globals.GlobalGrouping) should be used.
    
    Parameters:
    
    condition - A set of actual observing conditions
    
    targets - All targets relavant for this target.
    
    timespan - The timespan within the merit should be maximized.
    
    Returns:
    
    A merit.
  - isProgramOver
```
boolean isProgramOver(GlobalGrouping set)
```
    Test, if the observing program on the target is completed. Target that are completed are removed from the scheduler list. Normally, an EndpointDefining merit is needed to answer the completeness puzzle. If a target first encounters that it is program-over, the target should change its completeness flag.
  - getRemainingTime
```
long getRemainingTime(GlobalGrouping condition)
```
    Returns the time this target will remain observable under current weather conditions. This is only an advisory method and will not return a very accurate estimate.
  - getObservingTime
```
long getObservingTime(GlobalGrouping condition)
```
    Returns an estimate of the time required for an observation of this target.This is only an advisory method and will not return a very accurate estimate, but it should also work if the parameters handed over are invalid.
  - isAbort
```
boolean isAbort(GlobalGrouping set)
```
    Signals that the execution of this target should be aborted. This can happen during regular execution due to changing conditions, or due to previous errors encountered.
  - isRetry
```
boolean isRetry(GlobalGrouping set)
```
    Signals that the target should be retried immediately. Think of a target that consists of a couple of calibration stars. Pick one, this fails, so you can block the failed one, but immedeately retry the target. Retry should also take previous errors into account.
  - getLastFail
```
Appointable.Constraint getLastFail()
```
    The conditions which lately rendered this target unobservable
  - getLastMerit
```
double getLastMerit()
```
    The last measured merit.
  - getHighestMerit
```
double getHighestMerit()
```
    The highest merit ever achieved.
  - getDailyMerit
```
double getDailyMerit()
```
    The highest merit in the last 24 hours.
  - getHighestDate
```
Date getHighestDate()
```
    The date of the highest merit.
  - getDailyDate
```
Date getDailyDate()
```
    The date of the high daily merit.

Interface Appointable

Nested Class Summary

Method Summary

Methods inherited from interface stella.Handable

Methods inherited from interface target.TargetDefinition

Method Detail

getDaughters

isObservable

getActualMerit

isProgramOver

getRemainingTime

getObservingTime

isAbort

isRetry

getLastFail

getLastMerit

getHighestMerit

getDailyMerit

getHighestDate

getDailyDate