BlockMerit

java.lang.Object
- util.PropertyContainer
- - stella.merit.AbstractMerit
  - - stella.merit.BlockMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying
```
public class BlockMerit
extends AbstractMerit
```
A class defining a time-slot merit for a target that should be observed repetitive each night in the similar block fashion. A block is defined by the two keys KEY_BLOCK and KEY_DELAY and is constructed in the following way. The first number in the block key defines the immediate number of succession of (successful, if KEY_SUCCESS is true) observations that should be executed if the target has been picked first in the night, then the first number in delay specifies the wait time in ms until the second block becomes active. The second number in the comma-separated block list specifies the number of observations in the second block and so forth. The last entry in delay is ignored. If all blocks have been executed, no more picks will happen during that night. If not all blocks had been executed during a night, the next night nevertheless starts with the first block. The merit toggles between zero and one.
The default acts a a single successful pick per night.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private List<Integer>`	`blocks` The observing blocks holding the observing counts.
`private static String`	`DEFBLOCK` Default number of observations to force time-out.
`private static double`	`DEFBLOCKPRIORITY` Default block priority.
`private static String`	`DEFDELAY` Default value for the time-out.
`private static String`	`DEFNIGHTLENGTH` Default time-span for successful observations.
`private static String`	`DEFNIGHTREMAIN` Default time-span for successful observations.
`static boolean`	`DEFSUCCESS` The key pointing to the name of the time parameter.
`private static String`	`DEFTIME` Default time parameter name.
`private List<Long>`	`delays` The timeout between different blocks.
`static String`	`KEY_BLOCK` The number of targets that must be observed to force timeout.
`static String`	`KEY_BLOCKPRIORITY` The priority within a block (after first observation in the night).
`static String`	`KEY_DELAY` The key linked to the time-out in milliseconds.
`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_SUCCESS` The key pointing to the name of the time parameter.
`static String`	`KEY_TIME` The key pointing to the name of the time parameter.
`private boolean`	`nowarn` To avoid massup of log-lines.

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

BlockMerit(Map<String,String> prop)
Constructs a time-out merit.

Constructors
Constructor and Description
`BlockMerit(Map<String,String> prop)` Constructs a time-out merit.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getMerit(GlobalGrouping set, Appointable target, Collection<Appointable> 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_DELAY
```
public static final String KEY_DELAY
```
    The key linked to the time-out in milliseconds.
    
    See Also:
    
    Constant Field Values
  - KEY_BLOCK
```
public static final String KEY_BLOCK
```
    The number of targets that must be observed to force timeout.
    
    See Also:
    
    Constant Field Values
  - KEY_BLOCKPRIORITY
```
public static final String KEY_BLOCKPRIORITY
```
    The priority within a block (after first observation in the night).
    
    See Also:
    
    Constant Field Values
  - KEY_SUCCESS
```
public static final String KEY_SUCCESS
```
    The key pointing to the name of the time parameter.
    
    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
  - DEFDELAY
```
private static final String DEFDELAY
```
    Default value for the time-out.
    
    See Also:
    
    Constant Field Values
  - DEFBLOCK
```
private static final String DEFBLOCK
```
    Default number of observations to force time-out.
    
    See Also:
    
    Constant Field Values
  - DEFBLOCKPRIORITY
```
private static final double DEFBLOCKPRIORITY
```
    Default block priority. Rather high to ensure true blocking
    
    See Also:
    
    Constant Field Values
  - DEFSUCCESS
```
public static final boolean DEFSUCCESS
```
    The key pointing to the name of the time parameter.
    
    See Also:
    
    Constant Field Values
  - DEFNIGHTLENGTH
```
private static final String DEFNIGHTLENGTH
```
    Default time-span for successful observations.
    
    See Also:
    
    Constant Field Values
  - DEFNIGHTREMAIN
```
private static final String DEFNIGHTREMAIN
```
    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
  - blocks
```
private List<Integer> blocks
```
    The observing blocks holding the observing counts.
  - delays
```
private List<Long> delays
```
    The timeout between different blocks.
  - nowarn
```
private boolean nowarn
```
    To avoid massup of log-lines.
- Constructor Detail
  - BlockMerit
```
public BlockMerit(Map<String,String> 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<Appointable> 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.

Class BlockMerit

Field Summary

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class stella.merit.AbstractMerit

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

KEY_DELAY

KEY_BLOCK

KEY_BLOCKPRIORITY

KEY_SUCCESS

KEY_TIME

KEY_NIGHTLENGTH

KEY_NIGHTREMAIN

DEFDELAY

DEFBLOCK

DEFBLOCKPRIORITY

DEFSUCCESS

DEFNIGHTLENGTH

DEFNIGHTREMAIN

DEFTIME

blocks

delays

nowarn

Constructor Detail

BlockMerit

Method Detail

getMerit