TimeEncoding (Yamcs API 4.3.1 API)

java.lang.Object
- org.yamcs.utils.TimeEncoding

```
public class TimeEncoding
extends Object
```
This class provides times in terms of milliseconds since 1970TAI

Author:

nm

Field Summary

Fields
Modifier and Type Field and Description

static long INVALID_INSTANT

static long MAX_INSTANT

static long MIN_INSTANT

Fields
Modifier and Type	Field and Description
`static long`	`INVALID_INSTANT`
`static long`	`MAX_INSTANT`
`static long`	`MIN_INSTANT`

Constructor Summary

Constructors
Constructor and Description

TimeEncoding()

Constructors
Constructor and Description
`TimeEncoding()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static long`	`currentInstant()` Deprecated.
`static long`	`fromCalendar(Calendar cal)` Transforms the cal from UNIX (millisec since 1970) to instant
`static long`	`fromDate(Date date)` Transforms a Date from UNIX (millisec since 1970) to instant
`static long`	`fromGpsCcsdsTime(int coarseTime, byte fineTime)` we assume coarseTime to be always positive (corresponding to uint32_t in C)
`static long`	`fromGpsMillisec(long gpstime)`
`static long`	`fromGpsYearSecMillis(int year, int secOfYear, int millis)`
`static long`	`fromJ2000Millisec(long j2000time)`
`static long`	`fromTaiMillisec(long taitime)`
`static long`	`fromUnixMillisec(long milliseconds)` Transforms UNIX time (milliseconds since 1970) to instant
`static long`	`fromUnixTime(long milliseconds)` Deprecated. use `fromUnixMillisec`
`static long`	`fromUnixTime(long seconds, int microseconds)` Transforms UNIX time expressed in seconds and microseconds since 1970 to instant WARNING: this conversion will loose precision (microsecond to millisecond)
`static GpsCcsdsTime`	`getCurrentGpsTime()` Conversion from current instant to GPS time.
`static long`	`getInstantfromJavaGps(long javagps)`
`static long`	`getJavaGpsFromInstant(long instant)` JavaGps is number of milliseconds since 1970 that assumes no leap seconds from 1970 to GPS Epoch, and then continues with the leap seconds.
`static long`	`getWallclockTime()`
`static long`	`parse(String s)` parses an ISO 8601 UTC date into an instant
`static void`	`setUp()`
`static Calendar`	`toCalendar(long instant)` transforms instant into a java cal containing milliseconds since 1970
`static String`	`toCombinedFormat(long instant)`
`static GpsCcsdsTime`	`toGpsTime(long instant)` Conversion from instant to GPS time.
`static long`	`toGpsTimeMillisec(long instant)` Conversion from instant to GPS time (milliseconds since the GPS epoch).
`static String`	`toOrdinalDateTime(long instant)` Returns the instant formatted as UTC yyyy-DDDTHH:mm:ss.SSS
`static String`	`toString(long instant)` Returns the instant formatted as UTC yyyy-MM-DDTHH:mm:ss.SSSZ
`static long`	`toUnixTime(long instant)` Transforms instant to UNIX time expressed in milliseconds since 1970
`static TaiUtcConverter.DateTimeComponents`	`toUtc(long instant)`
`static String`	`toWinCompatibleDateTime(long instant)` Returns the instant in UTC time scale formatted as YYYY-DDDTHHhMMmSSsSSS so that is leads to an MS Windows compatible filename

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

- Field Detail
  - INVALID_INSTANT
```
public static final long INVALID_INSTANT
```
    See Also:
    
    Constant Field Values
  - MIN_INSTANT
```
public static final long MIN_INSTANT
```
    See Also:
    
    Constant Field Values
  - MAX_INSTANT
```
public static long MAX_INSTANT
```
- Constructor Detail
  - TimeEncoding
```
public TimeEncoding()
```
- Method Detail
  - setUp
```
public static void setUp()
                  throws RuntimeException
```
    Throws:
    
    RuntimeException
  - currentInstant
```
@Deprecated
public static long currentInstant()
```
    Deprecated.
    
    Returns the current wall clock time. Is the same with getWallclockTime Should use instead timeService.getMissionTime()
    
    Returns:
  - getWallclockTime
```
public static long getWallclockTime()
```
  - toString
```
public static String toString(long instant)
```
    Returns the instant formatted as UTC yyyy-MM-DDTHH:mm:ss.SSSZ
    
    Parameters:
    
    instant -
    
    Returns:
  - toOrdinalDateTime
```
public static String toOrdinalDateTime(long instant)
```
    Returns the instant formatted as UTC yyyy-DDDTHH:mm:ss.SSS
    
    Parameters:
    
    instant -
    
    Returns:
  - toWinCompatibleDateTime
```
public static String toWinCompatibleDateTime(long instant)
```
    Returns the instant in UTC time scale formatted as YYYY-DDDTHHhMMmSSsSSS so that is leads to an MS Windows compatible filename
    
    Parameters:
    
    instant -
    
    Returns:
  - toCombinedFormat
```
public static String toCombinedFormat(long instant)
```
  - fromGpsCcsdsTime
```
public static long fromGpsCcsdsTime(int coarseTime,
                                    byte fineTime)
```
    we assume coarseTime to be always positive (corresponding to uint32_t in C)
    
    Parameters:
    
    coarseTime - number of seconds from GPS epoch
    
    fineTime - number of 1/256 seconds
    
    Returns:
  - toGpsTime
```
public static GpsCcsdsTime toGpsTime(long instant)
```
    Conversion from instant to GPS time.
    
    Parameters:
    
    instant - yamcs time
    
    Returns:
    
    GPS time
  - getCurrentGpsTime
```
public static GpsCcsdsTime getCurrentGpsTime()
```
    Conversion from current instant to GPS time. Current time is the *nix time this function is called.
    
    Returns:
    
    GPS time
  - toGpsTimeMillisec
```
public static long toGpsTimeMillisec(long instant)
```
    Conversion from instant to GPS time (milliseconds since the GPS epoch).
    
    Parameters:
    
    instant - TimeEncoding instant
    
    Returns:
    
    GPS time
  - fromGpsYearSecMillis
```
public static long fromGpsYearSecMillis(int year,
                                        int secOfYear,
                                        int millis)
```
  - toUtc
```
public static TaiUtcConverter.DateTimeComponents toUtc(long instant)
```
  - parse
```
public static long parse(String s)
```
    parses an ISO 8601 UTC date into an instant
    
    Parameters:
    
    s -
    
    Returns:
  - fromUnixTime
```
@Deprecated
public static long fromUnixTime(long milliseconds)
```
    Deprecated. use fromUnixMillisec
    
    Transforms UNIX time (milliseconds since 1970) to instant
    
    Parameters:
    
    milliseconds -
    
    Returns:
  - fromUnixMillisec
```
public static long fromUnixMillisec(long milliseconds)
```
    Transforms UNIX time (milliseconds since 1970) to instant
    
    Parameters:
    
    milliseconds -
    
    Returns:
  - fromUnixTime
```
public static long fromUnixTime(long seconds,
                                int microseconds)
```
    Transforms UNIX time expressed in seconds and microseconds since 1970 to instant WARNING: this conversion will loose precision (microsecond to millisecond)
    
    Parameters:
    
    seconds -
    
    microseconds -
    
    Returns:
  - toUnixTime
```
public static long toUnixTime(long instant)
```
    Transforms instant to UNIX time expressed in milliseconds since 1970
    
    Parameters:
    
    instant -
    
    Returns:
  - fromCalendar
```
public static long fromCalendar(Calendar cal)
```
    Transforms the cal from UNIX (millisec since 1970) to instant
    
    Parameters:
    
    cal -
    
    Returns:
  - fromDate
```
public static long fromDate(Date date)
```
    Transforms a Date from UNIX (millisec since 1970) to instant
  - toCalendar
```
public static Calendar toCalendar(long instant)
```
    transforms instant into a java cal containing milliseconds since 1970
    
    Parameters:
    
    instant -
    
    Returns:
  - getJavaGpsFromInstant
```
public static long getJavaGpsFromInstant(long instant)
```
    JavaGps is number of milliseconds since 1970 that assumes no leap seconds from 1970 to GPS Epoch, and then continues with the leap seconds.
    
    Parameters:
    
    instant -
    
    Returns:
  - getInstantfromJavaGps
```
public static long getInstantfromJavaGps(long javagps)
```
  - fromGpsMillisec
```
public static long fromGpsMillisec(long gpstime)
```
    Parameters:
    
    gpstime - number of millisec from GPS epoch
    
    Returns:
  - fromTaiMillisec
```
public static long fromTaiMillisec(long taitime)
```
  - fromJ2000Millisec
```
public static long fromJ2000Millisec(long j2000time)
```

Class TimeEncoding

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_INSTANT

MIN_INSTANT

MAX_INSTANT

Constructor Detail

TimeEncoding

Method Detail

setUp

currentInstant

getWallclockTime

toString

toOrdinalDateTime

toWinCompatibleDateTime

toCombinedFormat

fromGpsCcsdsTime

toGpsTime

getCurrentGpsTime

toGpsTimeMillisec

fromGpsYearSecMillis

toUtc

parse

fromUnixTime

fromUnixMillisec

fromUnixTime

toUnixTime

fromCalendar

fromDate

toCalendar

getJavaGpsFromInstant

getInstantfromJavaGps

fromGpsMillisec

fromTaiMillisec

fromJ2000Millisec