stella.merit

Class ForcedSwitchOnMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.ForcedSwitchOnMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

public class ForcedSwitchOnMerit
extends AbstractMerit

A class defining a time-slot merit for calibration observations that should not start before a named switch KEY_SWITCH is true and has been toggled to true at least KEY_ONFOR milliseconds.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	DEFONFOR Default time the switch must have been on, ms.
static String	KEY_ONFOR The time that must have been passed since the last switch-on.
static String	KEY_SWITCH The key linked to the name of the switch that must be on.

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

Method Summary

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

public static final String KEY_SWITCH

The key linked to the name of the switch that must be on.

See Also:

Constant Field Values

KEY_ONFOR

public static final String KEY_ONFOR

The time that must have been passed since the last switch-on.

See Also:

Constant Field Values

DEFONFOR

private static final long DEFONFOR

Default time the switch must have been on, ms.

See Also:

Constant Field Values

Constructor Detail

ForcedSwitchOnMerit

public ForcedSwitchOnMerit(Map prop)

Constructs a time-out merit. It defaults the KEY_ONFOR 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 dummy,
                       Collection ignore,
                       long within)

Calculates the actual time slot merit. If the switch named by KEY_SWITCH is on for at least KEY_ONFOR milliseconds we return one. If the switch is unknown, we return zero.

Parameters:

set - Current observing conditions.

dummy - The actual target.

ignore - All targets, observable or not.

within - The relevant time span in ms.