TimeInstant (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.simulator.TimeInstant

All Implemented Interfaces:

java.lang.Comparable<TimeInstant>
```
public final class TimeInstant
extends java.lang.Object
implements java.lang.Comparable<TimeInstant>
```
Represents points in simulation time. Is used to indicate points in simulation time at which the state of the model changes. Each point in simulation time is represented by an individual object of this class and offers its own methods for arithmetic operations.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Felix Klueckmann Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors
Constructor and Description
`TimeInstant(java.util.Calendar calendar)` Constructs a TimeInstant object that represents the given instant of time specified by the Calendar object.
`TimeInstant(java.util.Calendar calendar, boolean applyPrefferdTimeZoneFromCalendar)` Constructs a TimeInstant object that represents the given instant of time specified by the Calendar object.
`TimeInstant(java.util.Date date)` Constructs a TimeInstant object that represents the given instant of time specified by the Date object.
`TimeInstant(double timeInReferenceUnit)` Constructs a TimeInstant object with the given time value in the time unit of the reference time.
`TimeInstant(double time, java.util.concurrent.TimeUnit unit)` Constructs a TimeInstant object with the given time value in the time unit given as second parameter.
`TimeInstant(long timeInReferenceUnit)` Constructs a TimeInstant object with the given time value in the time unit of the reference time.
`TimeInstant(long time, java.util.concurrent.TimeUnit unit)` Constructs a TimeInstant object with the given time value in the time unit of the given parameter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(TimeInstant anotherInstant)` Compares the given TimeInstant to this TimeInstant.
`boolean`	`equals(java.lang.Object o)` Indicates whether this TimeInstant is equal to the given parameter.
`TimeInstant`	`getBeginOf(java.util.concurrent.TimeUnit smallestUnit)` Determines that last instant prior to this instant at which a new period of the unit provided "begins", which means smaller units are zero.
`java.util.TimeZone`	`getPreferredTimeZone()` The preferred time zone for printing this time instant.
`java.util.Calendar`	`getTimeAsCalender()` Returns the value of this TimeInstant object as a Calender object.
`java.util.Date`	`getTimeAsDate()` Returns the value of this TimeInstant object as a Date object.
`double`	`getTimeAsDouble()` Returns the value of this TimeInstant object as a double type in the time unit of the reference time.
`double`	`getTimeAsDouble(java.util.concurrent.TimeUnit unit)` Returns the value of this TimeInstant object as a double type in the time unit given as a parameter.
`long`	`getTimeInEpsilon()` Returns the value of the TimeInstant object as a long type in the time unit of epsilon
`long`	`getTimeRounded()` Returns the value of this TimeInstant object as a long type in the time unit of the reference time.
`long`	`getTimeRounded(java.util.concurrent.TimeUnit unit)` Returns the value of this TimeInstant object as a long type in the time unit given as a parameter.
`long`	`getTimeTruncated()` Returns the value of this TimeInstant object as a long type in the time unit of the reference time.
`long`	`getTimeTruncated(java.util.concurrent.TimeUnit unit)` Returns the value of this TimeInstant object as a long type in the time unit given as a parameter.
`int`	`hashCode()` Returns a hash code value for the object.
`static boolean`	`isAfter(TimeInstant a, TimeInstant b)` Checks if the first of two points of simulation time is after the second.
`static boolean`	`isAfterOrEqual(TimeInstant a, TimeInstant b)` Checks if the first of two points of simulation time is after the second or equal to the second.
`static boolean`	`isBefore(TimeInstant a, TimeInstant b)` Checks if the first of two points of simulation time is before the second.
`static boolean`	`isBeforeOrEqual(TimeInstant a, TimeInstant b)` Checks if the first of two points of simulation time is before the second or equal to the second.
`static boolean`	`isEqual(TimeInstant a, TimeInstant b)` Checks if the two TimeInstant parameters describe the same point of simulation time.
`void`	`setPreferredTimeZone(java.util.TimeZone preferredTimeZone)` Sets the preferred time zone for printing this time instant.
`java.lang.String`	`toString()` Returns the String Representation of this TimeInstant according to the TimeFormatter.
`java.lang.String`	`toString(int digits)` Returns the String Representation of this TimeInstant according to the TimeFormatter, truncating digits after the decimal point if necessary.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TimeInstant
```
public TimeInstant(long time,
                   java.util.concurrent.TimeUnit unit)
```
    Constructs a TimeInstant object with the given time value in the time unit of the given parameter. It represents a time instant in simulation time. Note that trying to create a TimeInstant object The simulation will also stop immediately if the TimeSpan is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    time - long : The time value of this TimeInstant in the time unit of unit.
    
    unit - TimeUnit: the TimeUnit
  - TimeInstant
```
public TimeInstant(long timeInReferenceUnit)
```
    Constructs a TimeInstant object with the given time value in the time unit of the reference time. It represents a time Instant in simulation time.
    
    Parameters:
    
    timeInReferenceUnit - long : The time value of this TimeInstant in the time unit of the reference time.
  - TimeInstant
```
public TimeInstant(double time,
                   java.util.concurrent.TimeUnit unit)
```
    Constructs a TimeInstant object with the given time value in the time unit given as second parameter. It represents a time Instant in simulation time.
    
    Parameters:
    
    time - double : The time value of this TimeInstant in the time unit of the reference time.
    
    unit - TimeUnit : the time unit
  - TimeInstant
```
public TimeInstant(double timeInReferenceUnit)
```
    Constructs a TimeInstant object with the given time value in the time unit of the reference time. It represents a time Instant in simulation time.
    
    Parameters:
    
    timeInReferenceUnit - double : The time value of this TimeInstant in the time unit of the reference time.
  - TimeInstant
```
public TimeInstant(java.util.Calendar calendar,
                   boolean applyPrefferdTimeZoneFromCalendar)
```
    Constructs a TimeInstant object that represents the given instant of time specified by the Calendar object. The preferred time zone for output will can either be adopted from the Calendar object or not be set.
    
    Parameters:
    
    calendar - Calendar : the instant of time that is represented by this TimeIstant
    
    applyPrefferdTimeZoneFromCalendar - boolean : Use the time zone as set in calendar for output (true) or use UTC as default time zone for output (false)
    
    See Also:
    
    Calendar
  - TimeInstant
```
public TimeInstant(java.util.Calendar calendar)
```
    Constructs a TimeInstant object that represents the given instant of time specified by the Calendar object. UTC will be used as default time zone for output.
    
    See Also:
    
    Calendar
  - TimeInstant
```
public TimeInstant(java.util.Date date)
```
    Constructs a TimeInstant object that represents the given instant of time specified by the Date object.
    
    Parameters:
    
    date - Date : the instant of time that is represented by this TimeInstant
    
    See Also:
    
    Date
- Method Detail
  - getTimeInEpsilon
```
public long getTimeInEpsilon()
```
    Returns the value of the TimeInstant object as a long type in the time unit of epsilon
    
    Returns:
    
    long: the time value of the TimeInstant object as a long type in the time unit of epsilon
  - getTimeTruncated
```
public long getTimeTruncated(java.util.concurrent.TimeUnit unit)
```
    Returns the value of this TimeInstant object as a long type in the time unit given as a parameter. If the parameter has a coarser granularity than epsilon the returned value will be truncated, so lose precision.
    
    Returns:
    
    long: the time value of the TimeInstant object as a long type in the time unit given as a parameter or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - getTimeTruncated
```
public long getTimeTruncated()
```
    Returns the value of this TimeInstant object as a long type in the time unit of the reference time. If the parameter has a coarser granularity than epsilon the returned value will be truncated, so lose precision.
    
    Returns:
    
    long: the time value of the TimeInstant object as a long type in the time unit given as a parameter or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - getTimeRounded
```
public long getTimeRounded(java.util.concurrent.TimeUnit unit)
```
    Returns the value of this TimeInstant object as a long type in the time unit given as a parameter. If the parameter has a coarser granularity than epsilon the returned value will be rounded, so lose precision.
    
    Parameters:
    
    unit - the TimeUnit
    
    Returns:
    
    long: the time value of the TimeInstant object as a long type in the time unit given as a parameter or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - getTimeRounded
```
public long getTimeRounded()
```
    Returns the value of this TimeInstant object as a long type in the time unit of the reference time. If the parameter has a coarser granularity than epsilon the returned value will be rounded, so lose precision.
    
    Returns:
    
    long: the time value of the TimeInstant object as a long type in the time unit given as a parameter or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - getTimeAsCalender
```
public java.util.Calendar getTimeAsCalender()
```
    Returns the value of this TimeInstant object as a Calender object. Note that the TimeZone of the Calender object returend is set to this TimeInstant's preferred TimeZone (which defaults to UTC unless set differently).
    
    Returns:
    
    Calendar: a Calendar representation of this TimeInstant
  - getTimeAsDate
```
public java.util.Date getTimeAsDate()
```
    Returns the value of this TimeInstant object as a Date object.
    
    Returns:
    
    Date: a Date representation of this TimeInstant
  - getTimeAsDouble
```
public double getTimeAsDouble(java.util.concurrent.TimeUnit unit)
```
    Returns the value of this TimeInstant object as a double type in the time unit given as a parameter.
    
    Returns:
    
    double: the time value of the TimeInstant object as a double type in the time unit given as a parameter
  - getTimeAsDouble
```
public double getTimeAsDouble()
```
    Returns the value of this TimeInstant object as a double type in the time unit of the reference time.
    
    Returns:
    
    double: the time value of the TimeInstant object as a double type in the time unit given as a parameter
  - getPreferredTimeZone
```
public java.util.TimeZone getPreferredTimeZone()
```
    The preferred time zone for printing this time instant.
    
    Returns:
    
    TimeZone: the time zone to use for printing this TimeInstant.
  - setPreferredTimeZone
```
public void setPreferredTimeZone(java.util.TimeZone preferredTimeZone)
```
    Sets the preferred time zone for printing this time instant. Note that this time zone does not affect the internal representation of this TimeInstant (stored as multiple of Experiment's epsilon since the start of the epoch, i.e. January 1, 1970, 00:00:00 GMT); the preferred TimeZone just servers TimeFormatters generating a convenient output.
    
    Parameters:
    
    preferredTimeZone - java.util.TimeZone : The time value of this TimeInstant in the time unit of the reference time.
  - isBefore
```
public static boolean isBefore(TimeInstant a,
                               TimeInstant b)
```
    Checks if the first of two points of simulation time is before the second. Before means, that the time value of TimeInstant a is smaller and hence "earlier" than TimeInstant b. Note that this is a static method available through calling the class TimeInstant i.e. TimeInstant.isAfter(a,b) where a and b are valid TimeInstant objects.
    
    Parameters:
    
    a - TimeInstant : first comparand
    
    b - TimeInstant : second comparand
    
    Returns:
    
    boolean : True if a is before (earlier) than b
  - isAfter
```
public static boolean isAfter(TimeInstant a,
                              TimeInstant b)
```
    Checks if the first of two points of simulation time is after the second. After means, that the time value of TimeInstant a is larger and hence "later" than TimeInstant b. Note that this is a static method available through calling the class TimeInstant i.e. TimeInstant.isAfter(a,b) where a and b are valid TimeInstant objects.
    
    Parameters:
    
    a - TimeInstant : first comparand
    
    b - TimeInstant : second comparand
    
    Returns:
    
    boolean : True if a is after (later) than b
  - isAfterOrEqual
```
public static boolean isAfterOrEqual(TimeInstant a,
                                     TimeInstant b)
```
    Checks if the first of two points of simulation time is after the second or equal to the second. After means, that the time value of TimeInstant a is larger and hence after TimeInstant b. Equal means, that they both describe the same point in simulation time. Note that this is a static method available through calling the class TimeInstant i.e. TimeInstant.isAfterOrEqual(a,b) where a and b are valid timeInstant objects.
    
    Parameters:
    
    a - TimeInstant : first comparand
    
    b - TimeInstant : second comparand
    
    Returns:
    
    boolean : True if a is after (later than )b or equal to b
  - isEqual
```
public static boolean isEqual(TimeInstant a,
                              TimeInstant b)
```
    Checks if the two TimeInstant parameters describe the same point of simulation time. Note that this is a static method available through calling the class TimeInstant i.e. TimeInstant.isEqual(a,b) where a and b are valid TimeInstant objects.
    
    Parameters:
    
    a - TimeInstant : first comparand
    
    b - TimeInstant : second comparand
    
    Returns:
    
    boolean : True if both parameters describe same point of simulation time
  - isBeforeOrEqual
```
public static boolean isBeforeOrEqual(TimeInstant a,
                                      TimeInstant b)
```
    Checks if the first of two points of simulation time is before the second or equal to the second. Before means, that the time value of TimeInstant a is smaller and hence before TimeInstant b. Equal means, that they both describe the same point in simulation time. Note that this is a static method available through calling the class TimeInstant i.e. TimeInstant.isBeforeOrEqual(a,b) where a and b are valid timeInstant objects.
    
    Parameters:
    
    a - TimeInstant : first comparand
    
    b - TimeInstant : second comparand
    
    Returns:
    
    boolean : True if a is before (earlier than )b or equal to b
  - getBeginOf
```
public TimeInstant getBeginOf(java.util.concurrent.TimeUnit smallestUnit)
```
    Determines that last instant prior to this instant at which a new period of the unit provided "begins", which means smaller units are zero.
    Examples: Assume this TimeInstant is 28.12.2011 11:23:45:678. Calling getBeginOf(TimeUnit.TimeUnit.DAYS) yields 28.12.2011 00:00:00:000 (begin of current hour). Calling getBeginOf(TimeUnit.TimeUnit.MINUTES) yields 28.12.2011 11:23:00:000 (begin of current day). Note that days are interpreted with respect to this instant's preferred time zone.
    
    Parameters:
    
    smallestUnit - TimeUnit : the unit to begin (i.e. smaller units set to zero); must be TimeUnit.DAYS, TimeUnit.HOURS, TimeUnit.MINUTES, TimeUnit.SECONDS or TimeUnit.MILLISECONDS.
    
    Returns:
    
    TimeInstant: The TimeInstant at which the day/hour/minute/second/millisecond of the this TimeInstant has begun.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object. This method overrides java.lang.Object.hashCode() to support efficient treatment in HashMaps.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Indicates whether this TimeInstant is equal to the given parameter. Returns true if the obj argument is a TimeInstant and represents the same point of time as this TimeInstant; false otherwise. This method overrides java.lang.Object.equals()
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the reference object with which to compare.
  - compareTo
```
public int compareTo(TimeInstant anotherInstant)
```
    Compares the given TimeInstant to this TimeInstant. This method implements the Comparable Interface
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<TimeInstant>
    
    Parameters:
    
    anotherInstant - : The TimeInstant to be compared to this TimeInstant
  - toString
```
public java.lang.String toString()
```
    Returns the String Representation of this TimeInstant according to the TimeFormatter.
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString(), TimeFormatter
  - toString
```
public java.lang.String toString(int digits)
```
    Returns the String Representation of this TimeInstant according to the TimeFormatter, truncating digits after the decimal point if necessary.
    
    Parameters:
    
    digits - Maximum number of digits after decimal point
    
    See Also:
    
    Object.toString(), TimeFormatter

Class TimeInstant

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TimeInstant

TimeInstant

TimeInstant

TimeInstant

TimeInstant

TimeInstant

TimeInstant

Method Detail

getTimeInEpsilon

getTimeTruncated

getTimeTruncated

getTimeRounded

getTimeRounded

getTimeAsCalender

getTimeAsDate

getTimeAsDouble

getTimeAsDouble

getPreferredTimeZone

setPreferredTimeZone

isBefore

isAfter

isAfterOrEqual

isEqual

isBeforeOrEqual

getBeginOf

hashCode

equals

compareTo

toString

toString