stella.merit

Class DawnMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.ForcedTimeoutMerit

stella.merit.DawnMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

public class DawnMerit
extends ForcedTimeoutMerit

A dusk merit acts like a time out merit during night time, but on dawn it ignores its timeout and returns always its maximum. Dawn is defined if the sun is on its rising branch and the solar height is higher than KEY_DAWN.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFDAWN Default dawn, when we get active.
private static String	DEFSOLHEIGHT Default solar height parameter name.
static String	KEY_DAWN The key linked to the solar height at dawn.
static String	KEY_SOLHEIGHT The name of the solar height value.

Fields inherited from class stella.merit.ForcedTimeoutMerit

KEY_OBSERVE, KEY_SPAN, KEY_TIME, KEY_TIMEOUT

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
DawnMerit(Map prop) Constructs a dawn 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_SOLHEIGHT

public static final String KEY_SOLHEIGHT

The name of the solar height value.

See Also:

Constant Field Values

KEY_DAWN

public static final String KEY_DAWN

The key linked to the solar height at dawn.

See Also:

Constant Field Values

DEFSOLHEIGHT

private static final String DEFSOLHEIGHT

Default solar height parameter name.

See Also:

Constant Field Values

DEFDAWN

public static final double DEFDAWN

Default dawn, when we get active.

See Also:

Constant Field Values

Constructor Detail

DawnMerit

public DawnMerit(Map prop)

Constructs a dawn merit. It defaults the KEY_DAWN 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 Sun is rising and passed KEY_DAWN, then the full merit is returned, otherwise we behave like a forced time out merit.

Specified by:

getMerit in interface Meriting

Overrides:

getMerit in class ForcedTimeoutMerit

Parameters:

set - Current observing conditions.

target - The actual target.

ignore - All targets, observable or not.

within - The relevant time span in ms.