TimeSpan (DESMO-J 2.5.1c API)

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

All Implemented Interfaces:

java.lang.Comparable<TimeSpan>
```
public final class TimeSpan
extends java.lang.Object
implements java.lang.Comparable<TimeSpan>
```
Represents spans of simulation time. Each span of simulation time is represented by an individual object of this class and offers its own methods for arithmetic operations and comparison. Ensures that only valid spans of time are generated.

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TimeSpan.Builder` Use the Builder to create TimeSpans specified as the sum of durations with different TimeUnits Example (timeSpan with the length of one hour and 30 minutes): new TimeSpan.Builder().hours(1).minutes(30).build();

Constructor Summary

Constructors
Constructor and Description
`TimeSpan(double duration)` Constructs a TimeSpan object with the given time value in the time unit of the reference time.
`TimeSpan(double duration, java.util.concurrent.TimeUnit unit)` Constructs a TimeSpan object with the given time value in the given timeUnit.
`TimeSpan(long duration)` Constructs a TimeSpan object with the given time value in the time unit of the reference time.
`TimeSpan(long duration, java.util.concurrent.TimeUnit unit)` Constructs a TimeSpan 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(TimeSpan anotherTimeSpan)` Compares the given TimeSpan to this TimeSpan.
`boolean`	`equals(java.lang.Object obj)` Indicates whether this TimeSpan is equal to the given parameter.
`double`	`getTimeAsDouble()` Returns the value of this TimeSpan 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 TimeSpan object as a double type in the time unit given as a parameter.
`long`	`getTimeInEpsilon()` Returns the value of the TimeSpan object as a long type in the time unit of epsilon
`long`	`getTimeRounded()` Returns the value of this TimeSpan 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 TimeSpan object as a long type in the time unit given as a parameter.
`long`	`getTimeTruncated()` Returns the value of this TimeSpan 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 TimeSpan 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`	`isEqual(TimeSpan a, TimeSpan b)` Indicates whether TimeSpan a is equal to TimeSpan b, i.e. they are of equal length.
`static boolean`	`isLonger(TimeSpan a, TimeSpan b)` Checks if the first of two spans of simulation time is longer than the second.
`static boolean`	`isLongerOrEqual(TimeSpan a, TimeSpan b)` Checks if the first of two spans of simulation time is longer than the second or equal to the second.
`static boolean`	`isShorter(TimeSpan a, TimeSpan b)` Checks if the first of two spans of simulation time is shorter than the second.
`static boolean`	`isShorterOrEqual(TimeSpan a, TimeSpan b)` Checks if the first of two spans of simulation time is shorter than the second or equal to the second.
`boolean`	`isZero()` Indicates whether this TimeSpan is equal to 0.
`java.lang.String`	`toString()` Returns the String Representation of this TimeSpan.
`java.lang.String`	`toString(int digits)` Returns the String Representation of this TimeSpan 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
  - TimeSpan
```
public TimeSpan(long duration,
                java.util.concurrent.TimeUnit unit)
```
    Constructs a TimeSpan object with the given time value in the time unit of the given parameter. It represents a time span in simulation time. Note that trying to create a TimeSpan object with a negative value will stop the simulation immediately. The simulation will also stop immediately if the TimeSpan is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    duration - long : The time value of this TimeSpan
    
    unit - TimeUnit: the TimeUnit
  - TimeSpan
```
public TimeSpan(long duration)
```
    Constructs a TimeSpan object with the given time value in the time unit of the reference time. It represents a time span in simulation time. Note that trying to create a TimeSpan object with a negative value will stop the simulation immediately. The simulation will also stop immediately if the TimeSpan is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    duration - long : The time value of this TimeSpan in the time unit of the reference time.
  - TimeSpan
```
public TimeSpan(double duration,
                java.util.concurrent.TimeUnit unit)
```
    Constructs a TimeSpan object with the given time value in the given timeUnit. It represents a time span in simulation time. Note that trying to create a TimeSpan object with a negative value will stop the simulation immediately. The simulation will also stop immediately if the TimeSpan is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    duration - double : The time value of this TimeSpan in the time unit of the reference time.
    
    unit - TimeUnit : the time unit
  - TimeSpan
```
public TimeSpan(double duration)
```
    Constructs a TimeSpan object with the given time value in the time unit of the reference time. It represents a time span in simulation time. Note that trying to create a TimeSpan object with a negative value will stop the simulation immediately.The simulation will also stop immediately if the TimeSpan is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    duration - double : The time value of this TimeSpan in the time unit of the reference time.
- Method Detail
  - getTimeInEpsilon
```
public long getTimeInEpsilon()
```
    Returns the value of the TimeSpan object as a long type in the time unit of epsilon
    
    Returns:
    
    long: the time value of the TimeSpan 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 TimeSpan 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.
    
    Parameters:
    
    unit - : the TimeUnit
    
    Returns:
    
    long: the time value of the TimeSpan 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 TimeSpan 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 TimeSpan 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 TimeSpan 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 TimeSpan 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 TimeSpan 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 TimeSpan 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.
  - getTimeAsDouble
```
public double getTimeAsDouble(java.util.concurrent.TimeUnit unit)
```
    Returns the value of this TimeSpan object as a double type in the time unit given as a parameter.
    
    Returns:
    
    double: the time value of the TimeSpan object as a double type in the time unit given as a parameter
  - getTimeAsDouble
```
public double getTimeAsDouble()
```
    Returns the value of this TimeSpan object as a double type in the time unit of the reference time.
    
    Returns:
    
    double: the time value of the TimeSpan object as a double type in the time unit given as a parameter
  - isLonger
```
public static boolean isLonger(TimeSpan a,
                               TimeSpan b)
```
    Checks if the first of two spans of simulation time is longer than the second. Note that this is a static method available through calling the class TimeSpan i.e. TimeSpan.isLonger(a,b) where a and b are valid TimeSpan objects.
    
    Parameters:
    
    a - TimeSpan : first comparand
    
    b - TimeSpan : second comparand
    
    Returns:
    
    boolean : True if a is longer than b
  - isLongerOrEqual
```
public static boolean isLongerOrEqual(TimeSpan a,
                                      TimeSpan b)
```
    Checks if the first of two spans of simulation time is longer than the second or equal to the second. Note that this is a static method available through calling the class TimeSpan i.e. TimeSpan.isLonger(a,b) where a and b are valid TimeSpan objects.
    
    Parameters:
    
    a - TimeSpan : first comparand
    
    b - TimeSpan : second comparand
    
    Returns:
    
    boolean : True if a is longer than b or equal to b.
  - isShorter
```
public static boolean isShorter(TimeSpan a,
                                TimeSpan b)
```
    Checks if the first of two spans of simulation time is shorter than the second. Note that this is a static method available through calling the class TimeSpan i.e. TimeSpan.isShorter(a,b) where a and b are valid TimeSpan objects.
    
    Parameters:
    
    a - TimeSpan : first comparand
    
    b - TimeSpan : second comparand
    
    Returns:
    
    boolean : True if a is shorter than b
  - isShorterOrEqual
```
public static boolean isShorterOrEqual(TimeSpan a,
                                       TimeSpan b)
```
    Checks if the first of two spans of simulation time is shorter than the second or equal to the second. Note that this is a static method available through calling the class TimeSpan i.e. TimeSpan.isShorterOrEqual(a,b) where a and b are valid TimeSpan objects.
    
    Parameters:
    
    a - TimeSpan : first comparand
    
    b - TimeSpan : second comparand
    
    Returns:
    
    boolean : True if a is shorter than b or equal to b.
  - isEqual
```
public static boolean isEqual(TimeSpan a,
                              TimeSpan b)
```
    Indicates whether TimeSpan a is equal to TimeSpan b, i.e. they are of equal length.
    
    Parameters:
    
    a - TimeSpan: first comparand
    
    b - TimeSpan: second comparand
    
    Returns:
    
    true if a is equal to b; false otherwise.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Indicates whether this TimeSpan is equal to the given parameter. Returns true if the obj argument is a TimeSpan and is of equal length as this TimeSpan; false otherwise. This method overrides java.lang.Object.equals()
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if the obj argument is a TimeSpan and is of equal length as this TimeSpan; false otherwise.
  - isZero
```
public boolean isZero()
```
    Indicates whether this TimeSpan is equal to 0.
    
    Returns:
    
    true if this TimeSpan has a length of 0; false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object. This methode overides java.lang.Object.hashCode().The method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    int: a hash code value for this TimeSpan.
  - compareTo
```
public int compareTo(TimeSpan anotherTimeSpan)
```
    Compares the given TimeSpan to this TimeSpan. This method implements the Comparable Interface
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<TimeSpan>
    
    Parameters:
    
    anotherTimeSpan - The TimeSpan to be compared to this TimeSpan
    
    Returns:
    
    int: Returns a negative integer, zero, or a positive integer as this TimeSpan is shorter than, equal to, or longer than the given parameter.
  - toString
```
public java.lang.String toString()
```
    Returns the String Representation of this TimeSpan.
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()
  - toString
```
public java.lang.String toString(int digits)
```
    Returns the String Representation of this TimeSpan 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 TimeSpan

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TimeSpan

TimeSpan

TimeSpan

TimeSpan

Method Detail

getTimeInEpsilon

getTimeTruncated

getTimeTruncated

getTimeRounded

getTimeRounded

getTimeAsDouble

getTimeAsDouble

isLonger

isLongerOrEqual

isShorter

isShorterOrEqual

isEqual

equals

isZero

hashCode

compareTo

toString

toString