stella.merit

Class NightlyMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.NightlyMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

public class NightlyMerit
extends AbstractMerit

A class defining a time-slot merit for a target that should be observed up to KEY_PERNIGHT times in a night, at least separated by KEY_TIMEOUT. The merit decreases as the number of observations in that night reaches pernight.

See Also:

PerNightMerit, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFNIGHTLENGTH Default time-span for successful observations.
private static String	DEFNIGHTREMAIN Default time-span for successful observations.
private static int	DEFPERNIGHT Default number of observations to force time-out.
private static String	DEFTIME Default time parameter name.
private static long	DEFTIMEOUT Default value for the time-out.
static String	KEY_NIGHTLENGTH The key pointing to the name of the nightlength parameter.
static String	KEY_NIGHTREMAIN The key pointing to the name of the nightremain parameter.
static String	KEY_PERNIGHT The number of targets that must be observed to force timeout.
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.
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
NightlyMerit(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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

KEY_TIMEOUT

public static final String KEY_TIMEOUT

The key linked to the time-out in milliseconds.

See Also:

Constant Field Values

KEY_PERNIGHT

public static final String KEY_PERNIGHT

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

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

KEY_NIGHTLENGTH

public static final String KEY_NIGHTLENGTH

The key pointing to the name of the nightlength parameter.

See Also:

Constant Field Values

KEY_NIGHTREMAIN

public static final String KEY_NIGHTREMAIN

The key pointing to the name of the nightremain parameter.

See Also:

Constant Field Values

DEFTIMEOUT

private static final long DEFTIMEOUT

Default value for the time-out.

See Also:

Constant Field Values

DEFPERNIGHT

private static final int DEFPERNIGHT

Default number of observations to force time-out.

See Also:

Constant Field Values

DEFNIGHTLENGTH

private static final String DEFNIGHTLENGTH

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

DEFNIGHTREMAIN

private static final String DEFNIGHTREMAIN

Default time-span for successful observations.

See Also:

Constant Field Values

Constructor Detail

NightlyMerit

public NightlyMerit(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 zero is returned. If not, the succes being back KEY_PERNIGHT in time is looked at. If this date compared to the actual time is shorter than the night length, zero is returned, otherwise 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.