edu.wpi.rail.jrosbridge.messages.std

Class Int16MultiArray

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.std.Int16MultiArray

public class Int16MultiArray
extends Message

The std_msgs/Int16MultiArray message. Please look at the MultiArrayLayout message definition for documentation on all multiarrays.

Version:

April 1, 2014

Author:

Russell Toris -- rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_DATA The name of the data field for the message.
static String	FIELD_LAYOUT The name of the layout field for the message.
static String	TYPE The message type.

Fields inherited from class edu.wpi.rail.jrosbridge.messages.Message

EMPTY_MESSAGE

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

EMPTY_JSON

Constructor Summary

Constructors

Constructor and Description
Int16MultiArray() Create a new, empty Int16MultiArray.
Int16MultiArray(MultiArrayLayout layout, short[] data) Create a new Int16MultiArray with the given layout and data.

Method Summary

Methods

Modifier and Type	Method and Description
Int16MultiArray	clone() Create a clone of this Int16MultiArray.
static Int16MultiArray	fromJsonObject(javax.json.JsonObject jsonObject) Create a new Int16MultiArray based on the given JSON object.
static Int16MultiArray	fromJsonString(String jsonString) Create a new Int16MultiArray based on the given JSON string.
static Int16MultiArray	fromMessage(Message m) Create a new Int16MultiArray based on the given Message.
short	get(int index) Get the data value at the given index.
short[]	getData() Get the data array.
MultiArrayLayout	getLayout() Get the layout value of this Int16MultiArray.
int	size() Get the size of the array.

Methods inherited from class edu.wpi.rail.jrosbridge.messages.Message

getMessageType, setMessageType

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

FIELD_LAYOUT

public static final String FIELD_LAYOUT

The name of the layout field for the message.

See Also:

Constant Field Values

FIELD_DATA

public static final String FIELD_DATA

The name of the data field for the message.

See Also:

Constant Field Values

TYPE

public static final String TYPE

The message type.

See Also:

Constant Field Values

Constructor Detail

Int16MultiArray

public Int16MultiArray()

Create a new, empty Int16MultiArray.

Int16MultiArray

public Int16MultiArray(MultiArrayLayout layout,
               short[] data)

Create a new Int16MultiArray with the given layout and data. The array of data will be copied into this object.

Parameters:

layout - The specification of data layout.

data - The array of data.

Method Detail

getLayout

public MultiArrayLayout getLayout()

Get the layout value of this Int16MultiArray.

Returns:

The layout value of this Int16MultiArray.

size

public int size()

Get the size of the array.

Returns:

The size of the array.

get

public short get(int index)

Get the data value at the given index.

Parameters:

index - The index to get the data value of.

Returns:

The data value at the given index.

getData

public short[] getData()

Get the data array. Note that this array should never be modified directly.

Returns:

The data array.

clone

public Int16MultiArray clone()

Create a clone of this Int16MultiArray.

Overrides:

clone in class Message

fromJsonString

public static Int16MultiArray fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A Int16MultiArray message based on the given JSON string.

fromMessage

public static Int16MultiArray fromMessage(Message m)

Create a new Int16MultiArray based on the given Message. Any missing values will be set to their defaults.

Parameters:

m - The Message to parse.

Returns:

A Int16MultiArray message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A Int16MultiArray message based on the given JSON object.