globals.value

Class CurrentTime

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.value.AbstractValue

globals.value.AbstractTime

globals.value.CurrentTime

All Implemented Interfaces:

Increasing, Parameter, Value, Cloneable, EndpointConstraining, ExitCleaning, Initializable, PropertySupplying, Reloadable, ResourceSupplying

Direct Known Subclasses:

SettableTime, TimeSimulate

public class CurrentTime
extends AbstractTime
implements Increasing, EndpointConstraining

A general variable representing time. Extends the AbstractValue base class. Does not need any registereed additional Parameters.

Nested Class Summary

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 global (time).

Fields inherited from class globals.value.AbstractTime

ISO, ISOSTANDARD, UTC

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
CurrentTime(Map<String,String> prop) Constructs a new global representing time.

Method Summary

Modifier and Type	Method and Description
Long	getAscendTime(Number until) Returns the remaining time in ms.
Date	getTime() Returns the time as a date object.
Number	getValue() Returns the time as an Long object.
boolean	isCompleted(Appointable.Constraint lim, TargetDefinition dummy) Returns true, if the observing program on the target is finished.

Methods inherited from class globals.value.AbstractTime

getFormatted, rescanned, setValue

Methods inherited from class globals.value.AbstractValue

get, set

Methods inherited from class globals.parameter.AbstractParameter

createParameter, delivers, exit, getFormatted, getName, getPreserveFile, getString, getString, init, 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

get, getFormatted, getName, getString, set

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

reload

Field Detail

DEFNAME

public static final String DEFNAME

The name of this global (time).

See Also:

Constant Field Values

Constructor Detail

CurrentTime

public CurrentTime(Map<String,String> prop)

Constructs a new global representing time.

Method Detail

getValue

public Number getValue()

Returns the time as an Long object. Querries the system time and wraps it into a Long instance.

Specified by:

getValue in interface Value

getTime

public Date getTime()

Returns the time as a date object.

getAscendTime

public Long getAscendTime(Number until)

Returns the remaining time in ms.

Specified by:

getAscendTime in interface Increasing

Parameters:

until - The value in the future.

Returns:

A double carrying the remaining time or null if the time cannot be calculated.

isCompleted

public boolean isCompleted(Appointable.Constraint lim,
                           TargetDefinition dummy)

Description copied from interface: EndpointConstraining

Returns true, if the observing program on the target is finished. An observing program is finished either if the aimed-at number of successful observations has been done, or if the target will never be observable again.

Specified by:

isCompleted in interface EndpointConstraining