ikr.simlib.events.time

Class Duration

java.lang.Object

ikr.simlib.events.time.TimeBase

ikr.simlib.events.time.Duration

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>, java.io.Serializable, java.lang.Comparable<Duration>

public class Duration
extends TimeBase
implements java.lang.Comparable<Duration>

Represents the relative time between two points in time.

Can be added to PointInTime objects or other Duration objects. For the generation of new Duration objects, double values are parsed to the internal representation using long values. The method Math.round(double) is used to get the best fitting long value.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ikr.simlib.events.time.TimeBase

TimeBase.InvalidTimeBaseException

Field Summary

Fields

Modifier and Type	Field and Description
static Duration	ZERO

Fields inherited from class ikr.simlib.events.time.TimeBase

EXPORT_UNIT, EXPORT_VALUE

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

CREATE_INSTANCE_METHOD_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Duration(long value) Does not need to be positive
	Duration(PointInTime first, PointInTime second) This method returns the duration between two PointInTime objects. Be aware: this method assumes ordered arguments and may return negative durations! The result is positive if and only if second.isLaterThan(first).

Method Summary

Methods

Modifier and Type	Method and Description
static Duration	calculateSumOf(java.util.Collection<Duration> durations)
int	compareTo(Duration other)
static Duration	createInstance(SimNode ownNode, Parameters pars)
static Duration	from(double value, TimeUnits unit)
static Duration	fromDays(double days)
static Duration	fromHours(double hours)
static Duration	fromMicroSeconds(double microSeconds)
static Duration	fromMilliSeconds(double milliSeconds)
static Duration	fromMinutes(double minutes)
static Duration	fromNanoSeconds(double nanoSeconds)
static Duration	fromPicoSeconds(double picoSeconds)
static Duration	fromSeconds(double seconds)
static Duration	importBatch(ResultReader reader, java.lang.String name)
boolean	isGreaterThan(Duration other)
boolean	isGreaterThanOrEqualTo(Duration other)
boolean	isLessThan(Duration other)
boolean	isLessThanOrEqualTo(Duration other)
Duration	multiplyBy(double scale)
Duration	multiplyBy(long scale)
Duration	negated()
Duration	plus(Duration other)
double	ratio(Duration other) This method is to answer the relation of two durations, e.g.
Duration	selectLonger(Duration other) Return the longer of two durations.
Duration	selectShorter(Duration other) Return the shorter of two durations

Methods inherited from class ikr.simlib.events.time.TimeBase

changeTimeBase, changeTimeBase, equals, exportBatch, getTimeUnit, getValue, hashCode, internalToSeconds, secondsToInternal, toDays, toHours, toMicroSeconds, toMilliSeconds, toMinutes, toNanoSeconds, toPicoSeconds, toSeconds, toString, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static Duration ZERO

Constructor Detail

Duration

protected Duration(long value)

Does not need to be positive

Duration

public Duration(PointInTime first,
        PointInTime second)

This method returns the duration between two PointInTime objects.
Be aware: this method assumes ordered arguments and may return negative durations! The result is positive if and only if second.isLaterThan(first).

Parameters:

first - typically the earlier PointInTime

second - typically the later PointInTime

Method Detail

createInstance

public static Duration createInstance(SimNode ownNode,
                      Parameters pars)

fromDays

public static Duration fromDays(double days)

fromHours

public static Duration fromHours(double hours)

fromMinutes

public static Duration fromMinutes(double minutes)

fromSeconds

public static Duration fromSeconds(double seconds)

fromMilliSeconds

public static Duration fromMilliSeconds(double milliSeconds)

fromMicroSeconds

public static Duration fromMicroSeconds(double microSeconds)

fromNanoSeconds

public static Duration fromNanoSeconds(double nanoSeconds)

fromPicoSeconds

public static Duration fromPicoSeconds(double picoSeconds)

from

public static Duration from(double value,
            TimeUnits unit)

importBatch

public static Duration importBatch(ResultReader reader,
                   java.lang.String name)
                            throws ImportException

Throws:

ImportException

calculateSumOf

public static Duration calculateSumOf(java.util.Collection<Duration> durations)

plus

public Duration plus(Duration other)

ratio

public double ratio(Duration other)

This method is to answer the relation of two durations, e.g. how many seconds go in an hour?

Parameters:

other - divisor of the fraction

Returns:

the fraction this/other

multiplyBy

public Duration multiplyBy(long scale)

multiplyBy

public Duration multiplyBy(double scale)

negated

public Duration negated()

compareTo

public int compareTo(Duration other)

Specified by:

compareTo in interface java.lang.Comparable<Duration>

isGreaterThan

public boolean isGreaterThan(Duration other)

isGreaterThanOrEqualTo

public boolean isGreaterThanOrEqualTo(Duration other)

isLessThan

public boolean isLessThan(Duration other)

isLessThanOrEqualTo

public boolean isLessThanOrEqualTo(Duration other)

selectLonger

public Duration selectLonger(Duration other)

Return the longer of two durations.

Parameters:

other - the other value

Returns:

the longer of the two durations

selectShorter

public Duration selectShorter(Duration other)

Return the shorter of two durations

Parameters:

other - the other value

Returns:

the shorter of the two durations