globals.trigger

Class Observing

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.parameter.WatchController

globals.trigger.Observing

All Implemented Interfaces:

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

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 globals.parameter.WatchController

WatchController.ResetTask

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFNAME The name of this parameter.
private SimpleTrigger	mine The current value of this trigger.

Fields inherited from class globals.parameter.WatchController

KEY_ACCEPT, KEY_COARSE, KEY_DATEFORMAT, KEY_T0

Fields inherited from class globals.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

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

Constructors

Constructor and Description
Observing(Map<String,String> prop) Constructs a new observing trigger.

Method Summary

Modifier and Type	Method and Description
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.
void	init() Initializes the parameter with its class name.
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 globals.parameter.WatchController

afterAll, getWatches, registerParameter, rescanned

Methods inherited from class globals.parameter.AbstractParameter

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

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, 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, parseObject, reload, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface globals.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

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<String,String> prop)

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

Method Detail

init

public void init()
          throws InitException

Description copied from class: AbstractParameter

Initializes the parameter with its class name.

Specified by:

init in interface Initializable

Overrides:

init in class AbstractParameter

Throws:

InitException

getTrigger

public Boolean getTrigger()

Returns the trigger value as a Boolean object.

Specified by:

getTrigger in interface Triggering

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 Triggering

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 Triggering

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 Triggering

getElapsedToggleTime

public long getElapsedToggleTime()

Returns the time elapsed since the last toggle event.

Specified by:

getElapsedToggleTime in interface Triggering

toggleTrigger

public Boolean toggleTrigger()

Toggles the trigger and starts/stops all registered RollOverWatches.

Specified by:

toggleTrigger in interface Triggering