stella.util

Class TimeSimulate

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.value.AbstractValue

globals.value.AbstractTime

globals.value.CurrentTime

stella.util.TimeSimulate

All Implemented Interfaces:

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

public class TimeSimulate
extends CurrentTime
implements Simulating, ParameterDepending

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 double	accelerate Acceleration factor.
private long	faketime The time faked at simul start.
static String	KEY_DUSKSTART If present, only the day is deduced from offset time from twilight.
static String	KEY_FORDATE The key mapping to the date format to use.
static String	KEY_OFFSET The key mapping to the starting time offset of the accelerated time.
private Longitude	lambda For twilight fakes, this is the longitude.
private Latitude	phi For twilight fakes, this is the latitude.
private long	simulstart The time simulation started.

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

Method Summary

Modifier and Type	Method and Description
boolean	accelerate(double by)
Number	getValue() If we are in simulating mode, we calculate the simulated time by accelerating the time passed since simulation start and adding this adjusted span to the fake time deduced on simulation start.
private long	nextDusk(double height, double lambda, double phi)
void	registerParameter(Parameter p) If parameter is a latitude or a longitude, we keep it for calculating dusk simulation times.
boolean	startSimulate() On simulation start we try to deduce the time we should point to by going through the following list, stopping whenever a match is obtained: If KEY_DUSKSTART is set and we have a valid registered longitude and latitude, we calculate the next time the sun will reach the twilight (sun height) as stated in this property.
boolean	stopSimulate()

Methods inherited from class globals.value.CurrentTime

getAscendTime, getTime, isCompleted

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

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_FORDATE

public static final String KEY_FORDATE

The key mapping to the date format to use.

See Also:

Constant Field Values

simulstart

private long simulstart

The time simulation started.

faketime

private long faketime

The time faked at simul start.

accelerate

private double accelerate

Acceleration factor.

lambda

private Longitude lambda

For twilight fakes, this is the longitude.

phi

private Latitude phi

For twilight fakes, this is the latitude.

Constructor Detail

TimeSimulate

public TimeSimulate(Map<String,String> prop)

Method Detail

registerParameter

public void registerParameter(Parameter p)

If parameter is a latitude or a longitude, we keep it for calculating dusk simulation times.

Specified by:

registerParameter in interface ParameterDepending

startSimulate

public boolean startSimulate()

On simulation start we try to deduce the time we should point to by going through the following list, stopping whenever a match is obtained:

• If KEY_DUSKSTART is set and we have a valid registered longitude and latitude, we calculate the next time the sun will reach the twilight (sun height) as stated in this property. The simulated time is now the time at dusk.
• If KEY_OFFSET is set, we add it to the current system time and call this the current time.
• If KEY_FORDATE is set, we convert this ISO-date into a time and start the simulated time from here.
• If no parameter is set, we start from system time. Note that acceleration is still possible.

Specified by:

startSimulate in interface Simulating

nextDusk

private long nextDusk(double height,
                      double lambda,
                      double phi)

stopSimulate

public boolean stopSimulate()

Specified by:

stopSimulate in interface Simulating

accelerate

public boolean accelerate(double by)
                   throws UnsupportedOperationException

Specified by:

accelerate in interface Simulating

Throws:

UnsupportedOperationException

getValue

public Number getValue()

If we are in simulating mode, we calculate the simulated time by accelerating the time passed since simulation start and adding this adjusted span to the fake time deduced on simulation start.

Specified by:

getValue in interface Value

Overrides:

getValue in class CurrentTime

See Also:

startSimulate()