org.ka2ddo.yaac.core

Class WatchedStationsTracker.WatchedStation

java.lang.Object

org.ka2ddo.yaac.core.WatchedStationsTracker.WatchedStation

Enclosing class:

WatchedStationsTracker

public static class WatchedStationsTracker.WatchedStation
extends java.lang.Object

This class specifies the types of operations to be performed for a specifically tracked station or object.

Since:

PROVIDER_API_VERSION == 11

Author:

Andrew Pavlin, KA2DDO

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	callsign Station callsign-SSID or object name.
boolean	drawTrackStripe Boolean true if map rendering should draw a track stripe after a moving station/object.
boolean	hideLabel Suppress displaying the label (callsign or alias) for this station/object.
WatchedStationsTracker.Importance	importance Relative sort importance of this station.
boolean	isDoubleSizeIcon Draw this station/object using a double-sized icon so it is easier to find on the map.
boolean	keepOnMap Ensure that the map should pan and zoom as necessary to keep all such flagged objects visible.
boolean	makeSounds Make appropriate event sounds for this object if the Sounds plugin is being used and specifies that only specifically tracked stations should make noises.
static int	MASK_DOUBLE_SIZE_ICON Bitmask encoding for a tracked station that should drawn with a double-sized icon.
static int	MASK_DRAW_TRACK_STRIPE Bitmask encoding for a tracked station that should have a track stripe after it.
static int	MASK_HIDE_LABEL Bitmask encoding for a tracked station whose callsign should not be rendered on the map.
static int	MASK_KEEP_ON_MAP Bitmask encoding for a tracked station that should be kept on the map.
static int	MASK_MAKE_SOUNDS Bitmask encoding for a tracked station for which sound effects should be made.

Method Summary

Modifier and Type	Method and Description
int	getBitMaskEncoding() Get bitmask encoding of all the watched station flags.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

callsign

public final java.lang.String callsign

Station callsign-SSID or object name.

drawTrackStripe

public boolean drawTrackStripe

Boolean true if map rendering should draw a track stripe after a moving station/object.

MASK_DRAW_TRACK_STRIPE

public static final int MASK_DRAW_TRACK_STRIPE

Bitmask encoding for a tracked station that should have a track stripe after it.

Since:

PROVIDER_API_VERSION == 45

See Also:

drawTrackStripe, Constant Field Values

keepOnMap

public boolean keepOnMap

Ensure that the map should pan and zoom as necessary to keep all such flagged objects visible. Note this was the original concept of tracked stations.

MASK_KEEP_ON_MAP

public static final int MASK_KEEP_ON_MAP

Bitmask encoding for a tracked station that should be kept on the map.

Since:

PROVIDER_API_VERSION == 45

See Also:

keepOnMap, Constant Field Values

isDoubleSizeIcon

public boolean isDoubleSizeIcon

Draw this station/object using a double-sized icon so it is easier to find on the map.

MASK_DOUBLE_SIZE_ICON

public static final int MASK_DOUBLE_SIZE_ICON

Bitmask encoding for a tracked station that should drawn with a double-sized icon.

Since:

PROVIDER_API_VERSION == 45

See Also:

isDoubleSizeIcon, Constant Field Values

makeSounds

public boolean makeSounds

Make appropriate event sounds for this object if the Sounds plugin is being used and specifies that only specifically tracked stations should make noises.

MASK_MAKE_SOUNDS

public static final int MASK_MAKE_SOUNDS

Bitmask encoding for a tracked station for which sound effects should be made.

Since:

PROVIDER_API_VERSION == 45

See Also:

makeSounds, Constant Field Values

hideLabel

public boolean hideLabel

Suppress displaying the label (callsign or alias) for this station/object. Useful for private Objects used to put marks on the map.

MASK_HIDE_LABEL

public static final int MASK_HIDE_LABEL

Bitmask encoding for a tracked station whose callsign should not be rendered on the map.

Since:

PROVIDER_API_VERSION == 45

See Also:

hideLabel, Constant Field Values

importance

public WatchedStationsTracker.Importance importance

Relative sort importance of this station.

Method Detail

getBitMaskEncoding

public int getBitMaskEncoding()

Get bitmask encoding of all the watched station flags.

Returns:

int bitmask