stella.merit

Class ForcedTimeoutMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.ForcedTimeoutMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

Direct Known Subclasses:

DawnMerit

public class ForcedTimeoutMerit
extends AbstractMerit

A class defining a time-slot merit for a continuos observations with a forced time-out after the last successful observation. The target will not be picked if the time passed since the last successful observation of the target is below KEY_TIMEOUT.
If combined with a OneObservationMerit this merit can be used to additionally specify a number of maximum observations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFOBSERVE Default number of observations to force time-out.
private static long	DEFSPAN Default time-span for successful observations.
private static String	DEFTIME Default time parameter name.
private static long	DEFTIMEOUT Default value for the time-out.
static String	KEY_OBSERVE The number of targets that must be observed to force timeout.
static String	KEY_SPAN Time-span within the targets must have been observed for a time-out.
static String	KEY_TIME The key pointing to the name of the time parameter.
static String	KEY_TIMEOUT The key linked to the time-out in milliseconds.

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
ForcedTimeoutMerit(Map prop) Constructs a time-out merit.

Method Summary

Modifier and Type	Method and Description
double	getMerit(GlobalGrouping set, Appointable target, Collection ignore, long within) Calculates the actual time slot merit.

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_TIMEOUT

public static final String KEY_TIMEOUT

The key linked to the time-out in milliseconds.

See Also:

Constant Field Values

KEY_OBSERVE

public static final String KEY_OBSERVE

The number of targets that must be observed to force timeout.

See Also:

Constant Field Values

KEY_SPAN

public static final String KEY_SPAN

Time-span within the targets must have been observed for a time-out.

See Also:

Constant Field Values

KEY_TIME

public static final String KEY_TIME

The key pointing to the name of the time parameter.

See Also:

Constant Field Values

DEFTIMEOUT

private static final long DEFTIMEOUT

Default value for the time-out.

See Also:

Constant Field Values

DEFOBSERVE

private static final int DEFOBSERVE

Default number of observations to force time-out.

See Also:

Constant Field Values

DEFSPAN

private static final long DEFSPAN

Default time-span for successful observations.

See Also:

Constant Field Values

DEFTIME

private static final String DEFTIME

Default time parameter name.

See Also:

Constant Field Values

Constructor Detail

ForcedTimeoutMerit

public ForcedTimeoutMerit(Map prop)

Constructs a time-out merit. It defaults the KEY_TIMEOUT parameter. Proper creation should be done using the AbstractMerit.createMerit(java.util.Map<java.lang.String, java.lang.String>) method. This create method also takes care of proper parameter overloading.

Method Detail

getMerit

public double getMerit(GlobalGrouping set,
                       Appointable target,
                       Collection ignore,
                       long within)

Calculates the actual time slot merit. If the time passed (in ms) since the last observation is less than KEY_TIMEOUT, a merit of one is returned. If the target definition is not history aware, one is returned.

Parameters:

set - Current observing conditions.

target - The actual target.

ignore - All targets, observable or not.

within - The relevant time span in ms.