globals.value

Class SettableTime

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.value.AbstractValue

globals.value.AbstractTime

globals.value.CurrentTime

globals.value.SettableTime

All Implemented Interfaces:

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

Direct Known Subclasses:

AcceleratedTime, SimulatorTime

public class SettableTime
extends CurrentTime
implements ParameterDepending, AfterRegistering

A general variable representing time. This time is settable and advancable, making it useful for simulators that want to mimic different times.

This class uses a dirty trick. By implementing the WeatherDependingParameter interface, we get a hold of the weather station that will be notified in case of time advances, if it supports this.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private static DateFormat	DEFDATEFORMAT The default date formatter.
private List<DateFormat>	df The list of date formatters to try.
static String	KEY_DATEFORMAT The key mapping to the date format to use.
static String	KEY_DUSKSTART If present, only the day is deduced from offset time from twilight.
static String	KEY_OFFSET The key mapping to the starting time offset of the accelerated time.
static String	KEY_TIMEZONE The key mapping to the time zone format to use.
private Longitude	lambda For twilight fakes, this is the longitude.
private long	mstime The time that should be faked.
private Latitude	phi For twilight fakes, this is the latitude.

Fields inherited from class globals.value.CurrentTime

DEFNAME

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

Method Summary

Modifier and Type	Method and Description
void	advance(long add) Advances the time for the stated amount of milliseconds.
void	afterAll() For twilight times we are only ready once we have longitude and latitude.
Number	getValue() Returns the time as an Long object.
void	init() Initializes the parameter with its class name.
void	registerParameter(Parameter p) If parameter is a latitude or a longitude, we keep it.
double	rescanned(String key, String old, String newval) If offset or date format change, we act.
Object	set(Object date) Links the Parameter.set(java.lang.Object) to the setDate(java.lang.String) method.
void	setDate(Date fake) Sets a fake date.
boolean	setDate(String fake) Sets the fake time to the date represented by the argument string.
void	setJd(double jd) Sets a JD.
private void	setMsTime(long ms)

Methods inherited from class globals.value.CurrentTime

getAscendTime, getTime, isCompleted

Methods inherited from class globals.value.AbstractTime

getFormatted, setValue

Methods inherited from class globals.value.AbstractValue

get

Methods inherited from class globals.parameter.AbstractParameter

createParameter, delivers, exit, 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

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

reload

Field Detail

KEY_OFFSET

public static final String KEY_OFFSET

The key mapping to the starting time offset of the accelerated time.

See Also:

Constant Field Values

KEY_DUSKSTART

public static final String KEY_DUSKSTART

If present, only the day is deduced from offset time from twilight.

See Also:

Constant Field Values

KEY_DATEFORMAT

public static final String KEY_DATEFORMAT

The key mapping to the date format to use.

See Also:

Constant Field Values

KEY_TIMEZONE

public static final String KEY_TIMEZONE

The key mapping to the time zone format to use.

See Also:

Constant Field Values

DEFDATEFORMAT

private static final DateFormat DEFDATEFORMAT

The default date formatter.

mstime

private long mstime

The time that should be faked.

lambda

private Longitude lambda

For twilight fakes, this is the longitude.

phi

private Latitude phi

For twilight fakes, this is the latitude.

df

private List<DateFormat> df

The list of date formatters to try.

Constructor Detail

SettableTime

public SettableTime(Map<String,String> prop)

Constructs a new global representing a faked time.

Method Detail

init

public void init()

Description copied from class: AbstractParameter

Initializes the parameter with its class name.

Specified by:

init in interface Initializable

Overrides:

init in class AbstractParameter

afterAll

public void afterAll()

For twilight times we are only ready once we have longitude and latitude.

Specified by:

afterAll in interface AfterRegistering

registerParameter

public void registerParameter(Parameter p)

If parameter is a latitude or a longitude, we keep it.

Specified by:

registerParameter in interface ParameterDepending

rescanned

public double rescanned(String key,
                        String old,
                        String newval)

If offset or date format change, we act.

Specified by:

rescanned in interface Reloadable

Overrides:

rescanned in class AbstractTime

set

public Object set(Object date)

Links the Parameter.set(java.lang.Object) to the setDate(java.lang.String) method.

Specified by:

set in interface Parameter

Overrides:

set in class AbstractValue

Returns:

The previous value of this parameter.

setDate

public boolean setDate(String fake)

Sets the fake time to the date represented by the argument string.

setDate

public void setDate(Date fake)

Sets a fake date.

setJd

public void setJd(double jd)

Sets a JD.

setMsTime

private void setMsTime(long ms)

advance

public void advance(long add)

Advances the time for the stated amount of milliseconds.

getValue

public Number getValue()

Returns the time as an Long object. Returns the value of the time as it was either set, using setDate(java.lang.String) or advanced, using advance(long).

Specified by:

getValue in interface Value

Overrides:

getValue in class CurrentTime