stella.parameter
Class Observing

java.lang.Object
  util.PropertyContainer
      util.PropertyResources
          util.PropertyBundles
              stella.parameter.AbstractParameter
                  stella.parameter.WatchController
                      stella.parameter.Observing

All Implemented Interfaces:

Cloneable, Parameter, AfterRegistering, ParameterDepending, Trigger, ExitCleaning, Initializable, LocalizedSupplying, PropertySupplying, ResourceSupplying

public class Observing
extends WatchController
implements Trigger

A trigger that is true if the obersavtory is currently in the observing mode. For STELLA this means that the roof is open. Additionally, it serves a bunch of RollOverWatches. Whenever its setTrigger(java.lang.Boolean) method is called, all watches are started/stopped depending on the argument value.

Nested Class Summary

Nested classes/interfaces inherited from class stella.parameter.WatchController

WatchController.ResetTask

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.URLResource

Field Summary

static String	DEFNAME The name of this parameter.
private SimpleTrigger	mine The current value of this trigger.

Fields inherited from class stella.parameter.WatchController

KEY_ACCEPT, KEY_COARSE, KEY_DATEFORMAT, KEY_T0

Fields inherited from class stella.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

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.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Observing(Map prop)
Constructs a new observing trigger.

Method Summary

Object	get() Returns the trigger value as an object.
long	getElapsedToggleTime() Returns the time elapsed since the last toggle event.
Date	getLastToggleTime() Returns the toggle time of the trigger.
Boolean	getTrigger() Returns the trigger value as a Boolean object.
boolean	isTrue() Returns true if this trigger is true.
Object	set(Object bool) Sets the trigger value as the original Parameter method.
Boolean	setTrigger(Boolean to) Sets the trigger to the new value and returns the old value.
Boolean	toggleTrigger() Toggles the trigger and starts/stops all registered RollOverWatches.

Methods inherited from class stella.parameter.WatchController

afterAll, getWatches, registerParameter, rescanned

Methods inherited from class stella.parameter.AbstractParameter

createParameter, delivers, exit, getFormatted, getFormatted, getName, getPreserveFile, getString, getString, init, register, setName, toString

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, 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, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface stella.Parameter

getFormatted, getName, getString

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

Methods inherited from interface util.ResourceSupplying

getResource, getResourceAsStream, getResources

Field Detail

DEFNAME

public static final String DEFNAME

The name of this parameter.

See Also:

Constant Field Values

mine

private SimpleTrigger mine

The current value of this trigger.

Constructor Detail

Observing

public Observing(Map prop)

Constructs a new observing trigger. The starting value is always false.

Method Detail

getTrigger

public Boolean getTrigger()

Returns the trigger value as a Boolean object.

Specified by:

getTrigger in interface Trigger

get

public Object get()

Returns the trigger value as an object.

Specified by:

get in interface Parameter

isTrue

public boolean isTrue()

Returns true if this trigger is true.

Specified by:

isTrue in interface Trigger

setTrigger

public Boolean setTrigger(Boolean to)

Sets the trigger to the new value and returns the old value. If the current value of the trigger does not equal the new value, toggleTrigger() is called.

Specified by:

setTrigger in interface Trigger

set

public Object set(Object bool)

Sets the trigger value as the original Parameter method.

Specified by:

set in interface Parameter

Returns:

The previous value of this parameter.

getLastToggleTime

public Date getLastToggleTime()

Returns the toggle time of the trigger.

Specified by:

getLastToggleTime in interface Trigger

getElapsedToggleTime

public long getElapsedToggleTime()

Returns the time elapsed since the last toggle event.

Specified by:

getElapsedToggleTime in interface Trigger

toggleTrigger

public Boolean toggleTrigger()

Toggles the trigger and starts/stops all registered RollOverWatches.

Specified by:

toggleTrigger in interface Trigger