ikr.simlib.events.time

Class PointInTime

java.lang.Object

ikr.simlib.events.time.TimeBase

ikr.simlib.events.time.PointInTime

All Implemented Interfaces:

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

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

Represents an absolute point in time.

Can be created by adding a Duration to another PointInTime. For the generation of new PointInTime 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 PointInTime	MAX
static PointInTime	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	PointInTime(long value)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(PointInTime other)
static PointInTime	createInstance(SimNode ownNode, Parameters pars)
static PointInTime	from(double value, TimeUnits unit)
static PointInTime	fromDays(double days)
static PointInTime	fromHours(double hours)
static PointInTime	fromMicroSeconds(double microSeconds)
static PointInTime	fromMilliSeconds(double milliSeconds)
static PointInTime	fromMinutes(double minutes)
static PointInTime	fromNanoSeconds(double nanoSeconds)
static PointInTime	fromPicoSeconds(double picoSeconds)
static PointInTime	fromSeconds(double seconds) create a new time object from the given value (SI-unit)
static PointInTime	importBatch(ResultReader reader, java.lang.String name)
boolean	isAfter(PointInTime other) Compare two Time objects
boolean	isAfterOrEqual(PointInTime other)
boolean	isBefore(PointInTime other)
boolean	isBeforeOrEqual(PointInTime other)
PointInTime	plus(Duration duration)
PointInTime	selectEarliest(PointInTime other) Return the earlier of two points in time
PointInTime	selectLatest(PointInTime other) Return the later of two points in time
Duration	until(PointInTime other)

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 PointInTime ZERO

MAX

public static PointInTime MAX

Constructor Detail

PointInTime

protected PointInTime(long value)

Method Detail

createInstance

public static PointInTime createInstance(SimNode ownNode,
                         Parameters pars)

fromDays

public static PointInTime fromDays(double days)

fromHours

public static PointInTime fromHours(double hours)

fromMinutes

public static PointInTime fromMinutes(double minutes)

fromSeconds

public static PointInTime fromSeconds(double seconds)

create a new time object from the given value (SI-unit)

fromMilliSeconds

public static PointInTime fromMilliSeconds(double milliSeconds)

fromMicroSeconds

public static PointInTime fromMicroSeconds(double microSeconds)

fromNanoSeconds

public static PointInTime fromNanoSeconds(double nanoSeconds)

fromPicoSeconds

public static PointInTime fromPicoSeconds(double picoSeconds)

from

public static PointInTime from(double value,
               TimeUnits unit)

importBatch

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

Throws:

ImportException

until

public Duration until(PointInTime other)

Returns:

time span from this time to the other time, negative if other lies in the past

plus

public PointInTime plus(Duration duration)

compareTo

public int compareTo(PointInTime other)

Specified by:

compareTo in interface java.lang.Comparable<PointInTime>

isAfter

public boolean isAfter(PointInTime other)

Compare two Time objects

Parameters:

other - the Time to compare with the current object

Returns:

Whether the current object points to a later point in time than the parameter other.

isAfterOrEqual

public boolean isAfterOrEqual(PointInTime other)

isBefore

public boolean isBefore(PointInTime other)

isBeforeOrEqual

public boolean isBeforeOrEqual(PointInTime other)

selectLatest

public PointInTime selectLatest(PointInTime other)

Return the later of two points in time

Parameters:

other - the other value

Returns:

the later of the two points in time

selectEarliest

public PointInTime selectEarliest(PointInTime other)

Return the earlier of two points in time

Parameters:

other - the other value

Returns:

the earlier of the two points in time