stella.merit

Class BearingMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.BearingMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

public class BearingMerit
extends AbstractMerit

A merit calculating its gain from the desired bearing direction. If no explicit bearing via KEY_ALTBEARING and KEY_AZBEARING is supplied, the current value of the bearing parameter is querried. If this, too, is undefined, zero is returned.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BearingMerit.Bearing

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFALTTARGET Default altitude-target parameter name.
private static String	DEFAZTARGET Default azimuth-target parameter name.
private static double	DEFWEIGHT Default value for the priority impact.
static String	KEY_ALTBEARING The key linked to the altitude bearing requested.
static String	KEY_ALTTARGET The name of the AltTarget parameter.
static String	KEY_AZBEARING The key linked to the azimuth bearing requested.
static String	KEY_AZTARGET The name of the AzTarget parameter.
static String	KEY_BEARINGPARAMETER The key linked to the bearing parameter.
static String	KEY_WEIGHT The key linked to the impact of the slew-tima merit.

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
BearingMerit(Map<String,String> prop) Constructs a new airmass merit, defaulting all parameters if not explicetly given.

Method Summary

Modifier and Type	Method and Description
double	getMerit(GlobalGrouping set, Appointable target, Collection ignore, long dummy) Calculates the actual gain using the requested bearing and calculating the on-sky distance of this object to the bearing.

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_BEARINGPARAMETER

public static final String KEY_BEARINGPARAMETER

The key linked to the bearing parameter.

See Also:

Constant Field Values

KEY_AZBEARING

public static final String KEY_AZBEARING

The key linked to the azimuth bearing requested.

See Also:

Constant Field Values

KEY_ALTBEARING

public static final String KEY_ALTBEARING

The key linked to the altitude bearing requested.

See Also:

Constant Field Values

KEY_WEIGHT

public static final String KEY_WEIGHT

The key linked to the impact of the slew-tima merit.

See Also:

Constant Field Values

KEY_ALTTARGET

public static final String KEY_ALTTARGET

The name of the AltTarget parameter.

See Also:

Constant Field Values

KEY_AZTARGET

public static final String KEY_AZTARGET

The name of the AzTarget parameter.

See Also:

Constant Field Values

DEFWEIGHT

private static final double DEFWEIGHT

Default value for the priority impact.

See Also:

Constant Field Values

DEFALTTARGET

private static final String DEFALTTARGET

Default altitude-target parameter name.

See Also:

Constant Field Values

DEFAZTARGET

private static final String DEFAZTARGET

Default azimuth-target parameter name.

See Also:

Constant Field Values

Constructor Detail

BearingMerit

public BearingMerit(Map<String,String> prop)

Constructs a new airmass merit, defaulting all parameters if not explicetly given. 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 dummy)

Calculates the actual gain using the requested bearing and calculating the on-sky distance of this object to the bearing. Returns positive values also for targets below the horizon.

Parameters:

set - Current observing conditions.

target - The actual target.

ignore - All targets, observable or not.

dummy - The relevant time span in ms.