stella.xml
Class ForcedSwitchOnMerit

java.lang.Object
  extended by util.PropertyContainer
      extended by util.PropertyResources
          extended by util.PropertyBundles
              extended by stella.AbstractMerit
                  extended by stella.xml.ForcedSwitchOnMerit
All Implemented Interfaces:
Serializable, Cloneable, Meriting, Initializable, LocalizedSupplying, PropertySupplying, ResourceSupplying

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

Nested Class Summary
 
Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.URLResource
 
Field Summary
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.PropertyBundles
KEY_LOCALECOUNTRY, KEY_LOCALELANGUAGE, KEY_RESOURCEBUNDLES
 
Fields inherited from class util.PropertyResources
KEY_NOINITONCREATE, localurl, locate, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_URL, urlset
 
Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR
 
Fields inherited from interface util.ResourceSupplying
KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME
 
Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS
 
Constructor Summary
ForcedSwitchOnMerit(Map prop)
          Constructs a time-out merit.
 
Method Summary
 double getMerit(ParameterClustering set, TargetDefinition dummy, Collection ignore, long within)
          Calculates the actual time slot merit.
 
Methods inherited from class stella.AbstractMerit
createMerit, getInitializer, initMerit
 
Methods inherited from class util.PropertyBundles
clone, getLocalized, getLocalized, getLocalizedString, getLocalizedString, loadResource
 
Methods inherited from class util.PropertyResources
createFrom, createFrom, createFrom, getApplet, getAsResources, getLocalClassLoader, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, init, keyCreate, keyCreate, reload, setApplet
 
Methods inherited from class util.PropertyContainer
augment, augment, augment, 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, isNew, parseObject, reload, removeProperty, rescanned, setObject, setProperties, setProperty, stringProperties, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface util.ResourceSupplying
getResource, getResourceAsStream, getResources
 
Methods inherited from interface util.PropertySupplying
defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties
 
Methods inherited from interface util.Initializable
init
 

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) method. This create method also takes care of proper parameter overloading.

Method Detail

getMerit

public double getMerit(ParameterClustering set,
                       TargetDefinition 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 - The list of targetes relevant to the actual target.
within - The relevant time span in ms.