ikr.simlib.events.time

Class TimeBase

java.lang.Object

ikr.simlib.events.time.TimeBase

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>, java.io.Serializable

Direct Known Subclasses:

Duration, PointInTime

public abstract class TimeBase
extends java.lang.Object
implements ReflectionConstructable2<SimNode,Parameters>, java.io.Serializable

Common base class for @{link PointInTime} and @{link Duration}. Both have a single value in a time unit that is configurable system-wide. The difference is that PointInTime refers to a single system-wide reference ( PointInTime.ZERO), while Duration is a difference of two times.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeBase.InvalidTimeBaseException

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	EXPORT_UNIT
protected static java.lang.String	EXPORT_VALUE

Fields inherited from interface ikr.simlib.parameters.reflection.ReflectionConstructable

CREATE_INSTANCE_METHOD_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TimeBase(long value)

Method Summary

Methods

Modifier and Type	Method and Description
static void	changeTimeBase(double newTimeBase, java.lang.String newTimeUnit) This method allows to change the time-base before the first time object has been created.
static void	changeTimeBase(TimeUnits unit) This method allows to change the time-base before the first time object has been created.
boolean	equals(java.lang.Object obj)
void	exportBatch(ResultWriter writer, java.lang.String name)
static java.lang.String	getTimeUnit()
protected long	getValue()
int	hashCode()
static double	internalToSeconds(long internal) converts internal units to seconds
static long	secondsToInternal(double seconds) converts seconds to internal units (incl.
double	toDays()
double	toHours()
double	toMicroSeconds()
double	toMilliSeconds()
double	toMinutes()
double	toNanoSeconds()
double	toPicoSeconds()
double	toSeconds()
java.lang.String	toString()
java.lang.String	toString(double outputTimeBase, java.lang.String outputTimeUnit)
java.lang.String	toString(TimeUnits unit, int decimalPlaces)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXPORT_VALUE

protected static final java.lang.String EXPORT_VALUE

EXPORT_UNIT

protected static final java.lang.String EXPORT_UNIT

Constructor Detail

TimeBase

protected TimeBase(long value)

Method Detail

internalToSeconds

public static double internalToSeconds(long internal)

converts internal units to seconds

Parameters:

internal - time in internal units

Returns:

time in seconds

secondsToInternal

public static long secondsToInternal(double seconds)

converts seconds to internal units (incl. rounding)

Parameters:

seconds - time in seconds

Returns:

time in internal units

changeTimeBase

public static void changeTimeBase(TimeUnits unit)

This method allows to change the time-base before the first time object has been created.

Parameters:

unit - the new time unit

changeTimeBase

public static void changeTimeBase(double newTimeBase,
                  java.lang.String newTimeUnit)

This method allows to change the time-base before the first time object has been created.

Parameters:

newTimeBase - number of time units per second

newTimeUnit - string describing the new time unit

getValue

protected long getValue()

getTimeUnit

public static java.lang.String getTimeUnit()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(double outputTimeBase,
                        java.lang.String outputTimeUnit)

toString

public java.lang.String toString(TimeUnits unit,
                        int decimalPlaces)

toDays

public double toDays()

Returns:

double time value in days

toHours

public double toHours()

Returns:

double time value in hours

toMinutes

public double toMinutes()

Returns:

double time value in minutes

toSeconds

public double toSeconds()

Returns:

double time value in seconds

toMilliSeconds

public double toMilliSeconds()

Returns:

double time value in milliseconds

toMicroSeconds

public double toMicroSeconds()

Returns:

double time value in microseconds

toNanoSeconds

public double toNanoSeconds()

Returns:

double time value in nanoseconds

toPicoSeconds

public double toPicoSeconds()

Returns:

double time value in picoseconds

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

exportBatch

public void exportBatch(ResultWriter writer,
               java.lang.String name)
                 throws PrintException

Throws:

PrintException