stella

Interface Meriting

All Known Implementing Classes:

AbstractMerit, AbstractNightMerit, AbstractPhaseMerit, AfterPickMerit, AfterTimeMerit, AirmassMerit, AtTimeMerit, AvoidanceMerit, AvoidObservablesMerit, BearingMerit, BeforeAfterMerit, BlockMerit, BlockTimeMerit, ChunkTimeMerit, ConsecutiveMerit, ConstantMerit, DarkSkyMerit, DawnMerit, EvenlySpacedMerit, ExpressionMerit, FixedBlockMerit, FixedDelayMerit, FixedRateMerit, FollowingProgramMerit, ForcedSwitchOnMerit, ForcedTimeoutMerit, JdMerit, JdModulusMerit, MeridianTransitMerit, MiddayMerit, MidnightMerit, ModulusMerit, MoonAvoidanceMerit, NightlyMerit, NightOptimalAirmassMerit, NightOptimalMerit, NightStretchMerit, NumberMerit, OneObservationMerit, OppositionMerit, PatternMerit, PerNightBlockMerit, PerNightMerit, PhaseAvoidanceMerit, PhaseCoherentMerit, PhaseFillerMerit, PhaseMerit, PickRaiseMerit, PriorityJumpMerit, PriorityMerit, RandomizeGroupMerit, RandomMerit, RandomSpacedMerit, RepetitiveMerit, SlewTimeMerit, SouthMerit, SuccessorCloseMerit, SuccessorMerit, SunAvoidanceMerit, TerminalMerit, TransitMerit, TransitOnOffMerit, UserMerit, WindowMerit, ZenithMerit

public interface Meriting

The interface defining merits of observations. Implementations of this class are used for guiding the dispatch scheduling of observations. In an Sequencing instance, merits may be defined using xml-definitions. The overall merit function of a targat may be composed of multiple merit instances.
Concrete implementation must support constructorless construction. Initialization may be done with the initMerit(java.lang.Object) method.

Method Summary

Modifier and Type	Method and Description
Object	getInitializer() Returns the intializer used in this merit.
double	getMerit(GlobalGrouping set, Appointable target, Collection<Appointable> oftargets, long within) Calculates the maximal merit for a special target within the stated amount of time.
void	initMerit(Object init) Initializes this merit.

Method Detail

initMerit

void initMerit(Object init)

Initializes this merit. There is no guarantee that this method is ever called. If called, however, even a null argument may be a valid argument, depending on the concrete meriting type.

Parameters:

init - An object used for initialization.

getInitializer

Object getInitializer()

Returns the intializer used in this merit. Only a few instances will need this.

Returns:

null if no initializer is needed.

getMerit

double getMerit(GlobalGrouping set,
                Appointable target,
                Collection<Appointable> oftargets,
                long within)

Calculates the maximal merit for a special target within the stated amount of time. Non-time dependandt merits may readily ignore the time-span parameter. The provided list of targets should give all relevant targets, i.e. for subsets only the daughters. If the set of parameters is not sufficient for calculating a merit, zero should be returned.

Parameters:

set - Current observing conditions.

target - The actual target.

oftargets - All targets, observable or not.

within - The relevant time span in ms.