stella.merit

Class PriorityMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.PriorityMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

public class PriorityMerit
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	DEFIMPACT Default value for the priority impact.
private static double	DEFSTRETCH Default value for the priority stretch.
static String	KEY_IMPACT The key linked to the impact of the priority merit.
static String	KEY_PRIORITY The key linked to the priority of the target.
static String	KEY_STRETCH The key linked to the stretching factor of the priority.

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
PriorityMerit(Map prop) Constructs a new priority merit.

Method Summary

Modifier and Type	Method and Description
double	getMerit(GlobalGrouping set, Appointable target, Collection 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

KEY_IMPACT

public static final String KEY_IMPACT

The key linked to the impact of the priority merit.

See Also:

Constant Field Values

KEY_STRETCH

public static final String KEY_STRETCH

The key linked to the stretching factor of the priority.

See Also:

Constant Field Values

KEY_PRIORITY

public static final String KEY_PRIORITY

The key linked to the priority of the target.

See Also:

Constant Field Values

DEFIMPACT

private static final double DEFIMPACT

Default value for the priority impact.

See Also:

Constant Field Values

DEFSTRETCH

private static final double DEFSTRETCH

Default value for the priority stretch.

See Also:

Constant Field Values

Constructor Detail

PriorityMerit

public PriorityMerit(Map 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 target,
                       Collection 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.

target - The actual target.

ignore - All targets, observable or not.

dummy - The relevant time span in ms.