edu.wpi.rail.jrosbridge.primitives

Class Primitive

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.primitives.Primitive

Direct Known Subclasses:

TimeBase

public abstract class Primitive
extends JsonWrapper

Primitive objects are used as a wrapper for non-native ROS primitives. These primitives act as wrappers around JSON objects. This class also contains static functions for dealing with ROS' unsigned numbers.

Version:

April 1, 2014

Author:

Russell Toris - rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_MESSAGE The String representation of an empty primitive in JSON.

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

EMPTY_JSON

Constructor Summary

Constructors

Constructor and Description
Primitive(javax.json.JsonObject jsonObject, String primitiveType) Create a Primitive based on the given JSON object.
Primitive(String jsonString, String primitiveType) Create a Primitive based on the given String representation of a JSON object.

Method Summary

Methods

Modifier and Type	Method and Description
static int	fromUInt16(short value) Convert the given value in unsigned 16-bit representation into its actual value.
static int[]	fromUInt16(short[] values) Convert the given values in unsigned 16-bit representation into their actual values.
static long	fromUInt32(int value) Convert the given value in unsigned 32-bit representation into its actual value.
static long[]	fromUInt32(int[] values) Convert the given values in unsigned 32-bit representation into their actual values.
static BigInteger	fromUInt64(long value) Convert the given value in unsigned 64-bit representation into its actual value.
static BigInteger[]	fromUInt64(long[] values) Convert the given values in unsigned 64-bit representation into their actual values.
static short	fromUInt8(byte value) Convert the given value in unsigned 8-bit representation into its actual value.
static short[]	fromUInt8(byte[] values) Convert the given values in unsigned 8-bit representation into their actual values.
String	getPrimitiveType() Get the type of the primitive.
void	setPrimitiveType(String primitiveType) Set the type of the primitive.
static short	toUInt16(int value) Convert the given value to an unsigned 16-bit unsigned integer.
static short[]	toUInt16(int[] values) Convert the given values to unsigned 16-bit unsigned integers.
static int	toUInt32(long value) Convert the given value to an unsigned 32-bit unsigned integer.
static int[]	toUInt32(long[] values) Convert the given values to unsigned 32-bit unsigned integers.
static long	toUInt64(BigInteger value) Convert the given value to an unsigned 64-bit unsigned integer.
static long[]	toUInt64(BigInteger[] values) Convert the given values to unsigned 64-bit unsigned integers.
static byte	toUInt8(short value) Convert the given value to an unsigned 8-bit unsigned integer.
static byte[]	toUInt8(short[] values) Convert the given values to unsigned 8-bit unsigned integers.

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

clone, equals, hashCode, toJsonObject, toString

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_MESSAGE

public static final String EMPTY_MESSAGE

The String representation of an empty primitive in JSON.

See Also:

Constant Field Values

Constructor Detail

Primitive

public Primitive(String jsonString,
         String primitiveType)

Create a Primitive based on the given String representation of a JSON object.

Parameters:

jsonString - The JSON String to parse.

primitiveType - The type of the primitive (e.g., "geometry_msgs/Twist").

Primitive

public Primitive(javax.json.JsonObject jsonObject,
         String primitiveType)

Create a Primitive based on the given JSON object.

Parameters:

jsonObject - The JSON object containing the primitive data.

primitiveType - The type of the primitive (e.g., "time").

Method Detail

getPrimitiveType

public String getPrimitiveType()

Get the type of the primitive.

Returns:

The type of the primitive.

setPrimitiveType

public void setPrimitiveType(String primitiveType)

Set the type of the primitive.

Parameters:

primitiveType - The type of the primitive (e.g., "time").

toUInt8

public static byte toUInt8(short value)

Convert the given value to an unsigned 8-bit unsigned integer. This ignores the high 8-bits of the short.

Parameters:

value - The value to convert.

Returns:

The value encoded as an 8-bit unsigned integer.

toUInt8

public static byte[] toUInt8(short[] values)

Convert the given values to unsigned 8-bit unsigned integers. This ignores the high 8-bits of the input.

Parameters:

values - The values to convert.

Returns:

The values encoded as an 8-bit unsigned integer.

fromUInt8

public static short fromUInt8(byte value)

Convert the given value in unsigned 8-bit representation into its actual value. That is, all return values of this function will be positive.

Parameters:

value - The unsigned 8-bit value to convert.

Returns:

The value of the given 8-bit unsigned value.

fromUInt8

public static short[] fromUInt8(byte[] values)

Convert the given values in unsigned 8-bit representation into their actual values. That is, all return values of this function will be positive.

Parameters:

values - The unsigned 8-bit values to convert.

Returns:

The values of the given 8-bit unsigned values.

toUInt16

public static short toUInt16(int value)

Convert the given value to an unsigned 16-bit unsigned integer. This ignores the high 16-bits of the input.

Parameters:

value - The value to convert.

Returns:

The value encoded as an 16-bit unsigned integer.

toUInt16

public static short[] toUInt16(int[] values)

Convert the given values to unsigned 16-bit unsigned integers. This ignores the high 16-bits of the input.

Parameters:

values - The values to convert.

Returns:

The values encoded as an 16-bit unsigned integer.

fromUInt16

public static int fromUInt16(short value)

Convert the given value in unsigned 16-bit representation into its actual value. That is, all return values of this function will be positive.

Parameters:

value - The unsigned 16-bit value to convert.

Returns:

The value of the given 16-bit unsigned value.

fromUInt16

public static int[] fromUInt16(short[] values)

Convert the given values in unsigned 16-bit representation into their actual values. That is, all return values of this function will be positive.

Parameters:

values - The unsigned 16-bit values to convert.

Returns:

The values of the given 16-bit unsigned values.

toUInt32

public static int toUInt32(long value)

Convert the given value to an unsigned 32-bit unsigned integer. This ignores the high 32-bits of the input.

Parameters:

value - The value to convert.

Returns:

The value encoded as an 32-bit unsigned integer.

toUInt32

public static int[] toUInt32(long[] values)

Convert the given values to unsigned 32-bit unsigned integers. This ignores the high 32-bits of the input.

Parameters:

values - The values to convert.

Returns:

The values encoded as an 32-bit unsigned integer.

fromUInt32

public static long fromUInt32(int value)

Convert the given value in unsigned 32-bit representation into its actual value. That is, all return values of this function will be positive.

Parameters:

value - The unsigned 32-bit value to convert.

Returns:

The value of the given 32-bit unsigned value.

fromUInt32

public static long[] fromUInt32(int[] values)

Convert the given values in unsigned 32-bit representation into their actual values. That is, all return values of this function will be positive.

Parameters:

values - The unsigned 32-bit values to convert.

Returns:

The values of the given 64-bit unsigned values.

toUInt64

public static long toUInt64(BigInteger value)

Convert the given value to an unsigned 64-bit unsigned integer. This ignores the high 64-bits of the input.

Parameters:

value - The value to convert.

Returns:

The value encoded as an 64-bit unsigned integer.

toUInt64

public static long[] toUInt64(BigInteger[] values)

Convert the given values to unsigned 64-bit unsigned integers. This ignores the high 64-bits of the input.

Parameters:

values - The values to convert.

Returns:

The values encoded as an 64-bit unsigned integer.

fromUInt64

public static BigInteger fromUInt64(long value)

Convert the given value in unsigned 64-bit representation into its actual value. That is, all return values of this function will be positive.

Parameters:

value - The unsigned 64-bit value to convert.

Returns:

The value of the given 64-bit unsigned value.

fromUInt64

public static BigInteger[] fromUInt64(long[] values)

Convert the given values in unsigned 64-bit representation into their actual values. That is, all return values of this function will be positive.

Parameters:

values - The unsigned 64-bit values to convert.

Returns:

The values of the given 64-bit unsigned values.