edu.wpi.rail.jrosbridge.primitives

Class Time

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.primitives.Primitive

edu.wpi.rail.jrosbridge.primitives.TimeBase<Time>

edu.wpi.rail.jrosbridge.primitives.Time

All Implemented Interfaces:

Comparable<TimeBase<Time>>

public class Time
extends TimeBase<Time>

The ROS time primitive.

Version:

April 1, 2014

Author:

Russell Toris - rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The primitive type.

Fields inherited from class edu.wpi.rail.jrosbridge.primitives.TimeBase

FIELD_NSECS, FIELD_SECS, MILLI_TO_NSECS, MILLI_TO_SECS, nsecs, NSECS_TO_MILLI, NSECS_TO_SECS, secs, SECS_TO_MILLI, SECS_TO_NSECS

Fields inherited from class edu.wpi.rail.jrosbridge.primitives.Primitive

EMPTY_MESSAGE

Fields inherited from class edu.wpi.rail.jrosbridge.JsonWrapper

EMPTY_JSON

Constructor Summary

Constructors

Constructor and Description
Time() Create a new Time with a default of 0.
Time(double sec) Create a new Time with the given time in seconds (and partial seconds).
Time(int secs, int nsecs) Create a new Time with the given seconds and nanoseconds values.
Time(long nano) Create a new Time with the given time in nanoseconds.

Method Summary

Methods

Modifier and Type	Method and Description
Time	add(Time t) Add the given Time to this Time and return a new Time with that value.
Time	clone() Create a clone of this Time.
static Time	fromDate(Date date) Create a new Time from the given Java Data object.
static Time	fromJsonObject(javax.json.JsonObject jsonObject) Create a new Time based on the given JSON object.
static Time	fromJsonString(String jsonString) Create a new Time based on the given JSON string.
static Time	fromNano(long nano) Create a new Time message based on the given nanoseconds.
static Time	fromSec(double sec) Create a new Time message based on the given seconds.
boolean	isValid() Check if this Time is valid.
static Time	now() Create a new Time message based on the current system time.
static boolean	sleepUntil(Time t) Sleep until the given time.
Time	subtract(Time t) Subtract the given Time from this Time and return a new Time with that value.
Date	toDate() Crate a new Java Date object based on this message.

Methods inherited from class edu.wpi.rail.jrosbridge.primitives.TimeBase

compareTo, getNsecs, getSecs, isZero, toNSec, toSec

Methods inherited from class edu.wpi.rail.jrosbridge.primitives.Primitive

fromUInt16, fromUInt16, fromUInt32, fromUInt32, fromUInt64, fromUInt64, fromUInt8, fromUInt8, getPrimitiveType, setPrimitiveType, toUInt16, toUInt16, toUInt32, toUInt32, toUInt64, toUInt64, toUInt8, toUInt8

Methods inherited from class edu.wpi.rail.jrosbridge.JsonWrapper

equals, hashCode, toJsonObject, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

The primitive type.

See Also:

Constant Field Values

Constructor Detail

Time

public Time()

Create a new Time with a default of 0.

Time

public Time(int secs,
    int nsecs)

Create a new Time with the given seconds and nanoseconds values.

Parameters:

secs - The seconds value of this time.

nsecs - The nanoseconds value of this time.

Time

public Time(double sec)

Create a new Time with the given time in seconds (and partial seconds).

Parameters:

sec - The time in seconds.

Time

public Time(long nano)

Create a new Time with the given time in nanoseconds.

Parameters:

sec - The time in nanoseconds.

Method Detail

add

public Time add(Time t)

Add the given Time to this Time and return a new Time with that value.

Specified by:

add in class TimeBase<Time>

Parameters:

t - The Time to add.

Returns:

A new Time with the new value.

subtract

public Time subtract(Time t)

Subtract the given Time from this Time and return a new Time with that value.

Specified by:

subtract in class TimeBase<Time>

Parameters:

t - The Time to subtract.

Returns:

A new Time with the new value.

isValid

public boolean isValid()

Check if this Time is valid. A time is valid if it is non-zero.

Returns:

If this Time is valid.

toDate

public Date toDate()

Crate a new Java Date object based on this message.

Returns:

A new Java Date object based on this message.

sleepUntil

public static boolean sleepUntil(Time t)

Sleep until the given time.

Parameters:

t - The time to sleep until.

Returns:

If the sleep was successful.

clone

public Time clone()

Create a clone of this Time.

Specified by:

clone in class TimeBase<Time>

Returns:

A clone of this TimeBase.

now

public static Time now()

Create a new Time message based on the current system time. Note that this might not match the current ROS time.

Returns:

The new Time message.

fromSec

public static Time fromSec(double sec)

Create a new Time message based on the given seconds.

Parameters:

sec - The time in seconds.

Returns:

The new Time primitive.

fromNano

public static Time fromNano(long nano)

Create a new Time message based on the given nanoseconds.

Parameters:

nano - The time in nanoseconds.

Returns:

The new Time primitive.

fromDate

public static Time fromDate(Date date)

Create a new Time from the given Java Data object.

Parameters:

date - The Date to create a Time from.

Returns:

The resulting Time primitive.

fromJsonString

public static Time fromJsonString(String jsonString)

Create a new Time based on the given JSON string. Any missing values will be set to their defaults.

Parameters:

jsonString - The JSON string to parse.

Returns:

A Time message based on the given JSON string.

fromJsonObject

public static Time fromJsonObject(javax.json.JsonObject jsonObject)

Create a new Time based on the given JSON object. Any missing values will be set to their defaults.

Parameters:

jsonObject - The JSON object to parse.

Returns:

A Time message based on the given JSON object.