edu.wpi.rail.jrosbridge.primitives

Class Duration

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.primitives.Primitive

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

edu.wpi.rail.jrosbridge.primitives.Duration

All Implemented Interfaces:

Comparable<TimeBase<Duration>>

public class Duration
extends TimeBase<Duration>

The ROS duration 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
Duration() Create a new Duration with a default of 0.
Duration(double sec) Create a new Duration with the given duration in seconds (and partial seconds).
Duration(int secs, int nsecs) Create a new Duration with the given seconds and nanoseconds values.
Duration(long nano) Create a new Duration with the given duration in nanoseconds.

Method Summary

Methods

Modifier and Type	Method and Description
Duration	add(Duration d) Add the given Duration to this Duration and return a new Duration with that value.
Duration	clone() Create a clone of this Duration.
static Duration	fromJsonObject(javax.json.JsonObject jsonObject) Create a new Duration based on the given JSON object.
static Duration	fromJsonString(String jsonString) Create a new Duration based on the given JSON string.
static Duration	fromNano(long nano) Create a new Duration message based on the given nanoseconds.
static Duration	fromSec(double sec) Create a new Duration message based on the given seconds.
boolean	sleep() Attempt to sleep for the duration specified in this object.
Duration	subtract(Duration d) Subtract the given Duration from this Duration and return a new Duration with that value.

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

Duration

public Duration()

Create a new Duration with a default of 0.

Duration

public Duration(int secs,
        int nsecs)

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

Parameters:

secs - The seconds value of this duration.

nsecs - The nanoseconds value of this duration.

Duration

public Duration(double sec)

Create a new Duration with the given duration in seconds (and partial seconds).

Parameters:

sec - The duration in seconds.

Duration

public Duration(long nano)

Create a new Duration with the given duration in nanoseconds.

Parameters:

sec - The duration in nanoseconds.

Method Detail

add

public Duration add(Duration d)

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

Specified by:

add in class TimeBase<Duration>

Parameters:

d - The Duration to add.

Returns:

A new Duration with the new value.

subtract

public Duration subtract(Duration d)

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

Specified by:

subtract in class TimeBase<Duration>

Parameters:

d - The Duration to subtract.

Returns:

A new Duration with the new value.

sleep

public boolean sleep()

Attempt to sleep for the duration specified in this object.

Returns:

If the sleep was successful.

clone

public Duration clone()

Create a clone of this Duration.

Specified by:

clone in class TimeBase<Duration>

Returns:

A clone of this TimeBase.

fromSec

public static Duration fromSec(double sec)

Create a new Duration message based on the given seconds.

Parameters:

sec - The duration in seconds.

Returns:

The new Duration primitive.

fromNano

public static Duration fromNano(long nano)

Create a new Duration message based on the given nanoseconds.

Parameters:

nano - The duration in nanoseconds.

Returns:

The new Duration primitive.

fromJsonString

public static Duration fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A Duration message based on the given JSON string.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A Duration message based on the given JSON object.