TimeOperations (DESMO-J 2.5.1c API)

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

```
public final class TimeOperations
extends java.lang.Object
```
TimeOperations is an utility class that provides arithmetic operations for the time classes TimeInstant and TimeSpan. It also holds the time settings, i.e. the granularity (epsilon) and the reference time unit.

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.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static TimeInstant`	`add(TimeInstant instant, TimeSpan span)` Returns a new Time Instant determined from the instant passed to this method plus the time span passed to method.
`static TimeInstant`	`add(TimeSpan span, TimeInstant instant)` Returns a new Time Instant determined from the instant passed to this method plus the time span passed to method.
`static TimeSpan`	`add(TimeSpan a, TimeSpan b)` Returns a new TimeSpan object representing the sum of the given TimeSpan objects.
`static TimeSpan`	`diff(TimeInstant a, TimeInstant b)` Returns a new TimeSpan object representing the absolute difference of the given TimeInstant objects, i.e. the span of time between the two instants of time.
`static TimeSpan`	`diff(TimeSpan a, TimeSpan b)` Returns a new TimeSpan object representing the absolute difference of the given TimeSpan objects.
`static TimeSpan`	`divide(TimeSpan dividend, double divisor)` Returns a new TimeSpan object representing the quotient of the given TimeSpan and the divisor of type double.
`static double`	`divide(TimeSpan dividend, TimeSpan divisor)` Returns a new TimeSpan object representing the quotient of the given TimeSpan objects.
`static java.lang.String`	`formatTimeInstant(TimeInstant instant)` Formats the given instant of time according to the timeFormatter.
`static java.lang.String`	`formatTimeSpan(TimeSpan span)` Formats the given span of time according to the timeFormatter.
`static TimeFormatter`	`getDefaultTimeFormatter()` Sets the TimeFormatter used by this environment to a `SingleUnitTimeFormatter`, using the current reference unit and four floating point digits.
`static java.util.concurrent.TimeUnit`	`getEpsilon()` Returns the epsilon value representing the granularity of simulation time for this experiment.
`static TimeSpan`	`getEpsilonSpan()` Returns the smallest distinguishable TimeSpan.
`static java.util.concurrent.TimeUnit`	`getReferenceUnit()` Returns the reference time unit specifying what is meant by the simulation time step of 1 in statements without an explicit declaration of a time unit like in `new TimeSpan(5)`.
`static TimeInstant`	`getStartTime()` Returns the TimeInstant when the experiment has started.
`static TimeFormatter`	`getTimeFormatter()` Returns the time Formatter.
`static TimeSpan`	`multiply(double factor, TimeSpan span)` Returns a new TimeSpan object representing the product of the given TimeSpan and the factor of type double.
`static TimeSpan`	`multiply(TimeSpan span, double factor)` Returns a new TimeSpan object representing the product of the given TimeSpan and the factor of type double.
`static void`	`setReferenceUnitX(java.util.concurrent.TimeUnit referenceUnit)` Sets the reference time unit specifying what is meant by the simulation time step of 1 in statements without an explicit declaration of a time unit like in `new TimeSpan(5)`.
`static void`	`setTimeFormatter(TimeFormatter myTimeFormatter, boolean override)` Sets the time Formatter.
`static TimeInstant`	`subtract(TimeInstant instant, TimeSpan span)` Returns a new Time Instant determined from the instant passed to this method minus the time span passed to method.

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

- Method Detail
  - add
```
public static TimeSpan add(TimeSpan a,
                           TimeSpan b)
```
    Returns a new TimeSpan object representing the sum of the given TimeSpan objects. Note that the simulation will stop immediately if the resulting sum is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    a - TimeSpan : TimeSpan a
    
    b - TimeSpan : TimeSpan b
    
    Returns:
    
    TimeSpan : A new TimeSpan as the sum of the TimeSpan parameters
  - add
```
public static TimeInstant add(TimeSpan span,
                              TimeInstant instant)
```
    Returns a new Time Instant determined from the instant passed to this method plus the time span passed to method. In other words, this method determines the instant that is a given span after the instant provided. Note that the simulation will stop immediately if the resulting instant is larger than Long.MAX_VALUE-1 (in the unit of epsilon). The preferred time zone of the result is equal to the preferred time zone of parameter b.
    
    Parameters:
    
    span - TimeSpan : The TimeSpan to add...
    
    instant - TimeInstant : ...to this TimeInstant.
    
    Returns:
    
    TimeSpan : A new TimeInstant determined from given TimeInstant plus the given TimeSpan
  - add
```
public static TimeInstant add(TimeInstant instant,
                              TimeSpan span)
```
    Returns a new Time Instant determined from the instant passed to this method plus the time span passed to method. In other words, this method determines the instant that is a given span after the instant provided. Note that the simulation will stop immediately if the resulting instant is larger than Long.MAX_VALUE-1 (in the unit of epsilon). The preferred time zone of the result is equal to the preferred time zone of instant passed to this method.
    
    Parameters:
    
    instant - TimeInstant : The TimeInstant, to which...
    
    span - TimeSpan : ...this TimeSpan will be added
    
    Returns:
    
    TimeSpan : A new TimeInstant determined from given TimeInstant plus the given TimeSpan
  - subtract
```
public static TimeInstant subtract(TimeInstant instant,
                                   TimeSpan span)
```
    Returns a new Time Instant determined from the instant passed to this method minus the time span passed to method. In other words, this method determines the instant that is a given span before the instant provided. Note that the simulation will stop immediately if the resulting instant is smaller than 0 (in the unit of epsilon). The preferred time zone of the result is equal to the preferred time zone of instant passed to this method.
    
    Parameters:
    
    instant - TimeInstant : The TimeInstant, from which...
    
    span - TimeSpan : ...this TimeSpan will be subtracted
    
    Returns:
    
    TimeSpan : A new TimeInstant determined from given TimeInstant minus the given TimeSpan
  - diff
```
public static TimeSpan diff(TimeSpan a,
                            TimeSpan b)
```
    Returns a new TimeSpan object representing the absolute difference of the given TimeSpan objects.
    
    Parameters:
    
    a - TimeSpan : TimeSpan a
    
    b - TimeSpan : TimeSpan b
    
    Returns:
    
    TimeSpan : A new TimeSpan as the absolute difference of the TimeSpan parameters
  - diff
```
public static TimeSpan diff(TimeInstant a,
                            TimeInstant b)
```
    Returns a new TimeSpan object representing the absolute difference of the given TimeInstant objects, i.e. the span of time between the two instants of time. Note that the simulation will stop immediately if the resulting sum is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    a - TimeInstant : TimeInstant a
    
    b - TimeInstant : TimeInstant b
    
    Returns:
    
    TimeSpan : A new TimeSpan as the difference of the TimeSpan parameters
  - multiply
```
public static TimeSpan multiply(TimeSpan span,
                                double factor)
```
    Returns a new TimeSpan object representing the product of the given TimeSpan and the factor of type double. Note that the simulation will stop immediately if the resulting product is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    span - TimeSpan : The span of time
    
    factor - double : The scalar factor
    
    Returns:
    
    TimeSpan : A new TimeSpan as the product of span and factor
  - multiply
```
public static TimeSpan multiply(double factor,
                                TimeSpan span)
```
    Returns a new TimeSpan object representing the product of the given TimeSpan and the factor of type double. Note that the simulation will stop immediately if the resulting product is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    factor - double : The scalar factor
    
    span - TimeSpan : The span of time
    
    Returns:
    
    TimeSpan : A new TimeSpan as the product of span and factor
  - divide
```
public static double divide(TimeSpan dividend,
                            TimeSpan divisor)
```
    Returns a new TimeSpan object representing the quotient of the given TimeSpan objects.
    
    Parameters:
    
    dividend - TimeSpan : The dividend
    
    divisor - TimeSpan : The divisor
    
    Returns:
    
    TimeSpan : A new TimeSpan as the quotient of dividend and divisor
  - divide
```
public static TimeSpan divide(TimeSpan dividend,
                              double divisor)
```
    Returns a new TimeSpan object representing the quotient of the given TimeSpan and the divisor of type double. Note that the simulation will stop immediately if the resulting quotient is larger than Long.MAX_VALUE-1 (in the unit of epsilon).
    
    Parameters:
    
    dividend - TimeSpan : The dividend
    
    divisor - double : The divisor
    
    Returns:
    
    TimeSpan : A new TimeSpan as the quotient of divident and divisor
  - getEpsilon
```
public static java.util.concurrent.TimeUnit getEpsilon()
```
    Returns the epsilon value representing the granularity of simulation time for this experiment.
    
    Returns:
    
    TimeUnit : The granularity of simulation time
  - getEpsilonSpan
```
public static TimeSpan getEpsilonSpan()
```
    Returns the smallest distinguishable TimeSpan.
    
    Returns:
    
    TimeSpan : The smallest distinguishable TimeSpan, i.e. one interval of the epsilon unit
  - getReferenceUnit
```
public static java.util.concurrent.TimeUnit getReferenceUnit()
```
    Returns the reference time unit specifying what is meant by the simulation time step of 1 in statements without an explicit declaration of a time unit like in new TimeSpan(5).
    
    Returns:
    
    the reference time unit
  - setReferenceUnitX
```
public static void setReferenceUnitX(java.util.concurrent.TimeUnit referenceUnit)
```
    Sets the reference time unit specifying what is meant by the simulation time step of 1 in statements without an explicit declaration of a time unit like in new TimeSpan(5).
    
    Parameters:
    
    referenceUnit - the reference time unit
  - formatTimeInstant
```
public static java.lang.String formatTimeInstant(TimeInstant instant)
```
    Formats the given instant of time according to the timeFormatter.
    
    Parameters:
    
    instant - the instant of time to be formatted
  - formatTimeSpan
```
public static java.lang.String formatTimeSpan(TimeSpan span)
```
    Formats the given span of time according to the timeFormatter.
    
    Parameters:
    
    span - the span of time to be formatted
  - getTimeFormatter
```
public static TimeFormatter getTimeFormatter()
```
    Returns the time Formatter. This is a package private method for internal framework use only.
  - setTimeFormatter
```
public static void setTimeFormatter(TimeFormatter myTimeFormatter,
                                    boolean override)
```
    Sets the time Formatter.
    
    Parameters:
    
    myTimeFormatter - the Time Formatter
    
    override - indicates that a custom TimeFormatter is supplied (true). This formatter will persist even if future calls to this method provide additional TimeFormatters who have this parameter set to false. The default time TimeFormatter supplied during the Experiment setup will use override = false, so that the default formatter will only be used if no TimeFormatter has been explicitly set the the user.
  - getDefaultTimeFormatter
```
public static TimeFormatter getDefaultTimeFormatter()
```
    Sets the TimeFormatter used by this environment to a SingleUnitTimeFormatter, using the current reference unit and four floating point digits.
  - getStartTime
```
public static TimeInstant getStartTime()
```
    Returns the TimeInstant when the experiment has started.
    
    Returns:
    
    TimeInstant : The point in simulation time, the experiment has started.

Class TimeOperations

Method Summary

Methods inherited from class java.lang.Object

Method Detail

add

add

add

subtract

diff

diff

multiply

multiply

divide

divide

getEpsilon

getEpsilonSpan

getReferenceUnit

setReferenceUnitX

formatTimeInstant

formatTimeSpan

getTimeFormatter

setTimeFormatter

getDefaultTimeFormatter

getStartTime