stella.merit

Class PriorityJumpMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.PriorityJumpMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

public class PriorityJumpMerit
extends AbstractMerit

A simple priority merit. It uses two scaling parameters, #KEY_IMPACT and #KEY_STRETCH that can be overriden in the xml-definition. The user must provide a #KEY_PRIORITY that should be a simple integer. Smaller numbers means higher priority. The formula used for this merit is

 merit(t) = k·ef·p
 

Here, k is the #KEY_IMPACT factor, while f is the #KEY_STRETCH. The priority comes in with p. Note that this merit is not time dependant. Its range is between zero and positive infinity.
As a rule of thumb consider using priorities from ten up for engineering groups, below ten for science groups.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static double	DEFSCALE Default value for the priority stretch.
private static int	DEFSUCCESSCOUNT The default successful observations required for the precursor.
private static String	DEFTIME Default time parameter name.
private static double	DEFZERO Default value for the priority stretch.
static String	KEY_SCALE The key linked to the scaling factor k of the merit.
static String	KEY_SUCCESSCOUNT The number of observations required.
static String	KEY_TIME The name of the time parameter used.
static String	KEY_ZERO No more observations after this number of days after high trigger.
private static long	serialVersionUID

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
PriorityJumpMerit(Map<String,String> prop) Constructs a new priority merit.

Method Summary

Modifier and Type	Method and Description
double	getMerit(GlobalGrouping set, Appointable me, Collection<Appointable> ignore, long dummy) Calculates the priority merit stemming from the target priority.

Methods inherited from class stella.merit.AbstractMerit

createMerit, getInitializer, initMerit

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

KEY_TIME

public static final String KEY_TIME

The name of the time parameter used.

See Also:

Constant Field Values

KEY_SUCCESSCOUNT

public static final String KEY_SUCCESSCOUNT

The number of observations required.

See Also:

Constant Field Values

KEY_SCALE

public static final String KEY_SCALE

The key linked to the scaling factor k of the merit.

See Also:

Constant Field Values

KEY_ZERO

public static final String KEY_ZERO

No more observations after this number of days after high trigger.

See Also:

Constant Field Values

DEFTIME

private static final String DEFTIME

Default time parameter name.

See Also:

Constant Field Values

DEFSUCCESSCOUNT

private static final int DEFSUCCESSCOUNT

The default successful observations required for the precursor.

See Also:

Constant Field Values

DEFSCALE

private static final double DEFSCALE

Default value for the priority stretch.

See Also:

Constant Field Values

DEFZERO

private static final double DEFZERO

Default value for the priority stretch.

See Also:

Constant Field Values

Constructor Detail

PriorityJumpMerit

public PriorityJumpMerit(Map<String,String> prop)

Constructs a new priority merit. This constructor should never be used directly, create a priority merit with the AbstractMerit.createMerit(java.util.Map<java.lang.String, java.lang.String>) method. This create method also takes care of proper argument overloading, while normal construction always uses default values.
The default values for the #KEY_STRETCH and the #KEY_IMPACT factors are set.

Method Detail

getMerit

public double getMerit(GlobalGrouping set,
                       Appointable me,
                       Collection<Appointable> ignore,
                       long dummy)

Calculates the priority merit stemming from the target priority. Note that this merit does not need any of the current parameter values or of the target definition handed over. All its paramters are set during the AbstractMerit.createMerit(java.util.Map<java.lang.String, java.lang.String>) creation.

Parameters:

set - Current observing conditions.

me - The actual target.

ignore - All targets, observable or not.

dummy - The relevant time span in ms.