edu.wpi.rail.jrosbridge.messages.std

Class ByteMultiArray

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.std.ByteMultiArray

public class ByteMultiArray
extends Message

The std_msgs/ByteMultiArray 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
ByteMultiArray() Create a new, empty ByteMultiArray.
ByteMultiArray(MultiArrayLayout layout, byte[] data) Create a new ByteMultiArray with the given layout and data.

Method Summary

Methods

Modifier and Type	Method and Description
ByteMultiArray	clone() Create a clone of this ByteMultiArray.
static ByteMultiArray	fromJsonObject(javax.json.JsonObject jsonObject) Create a new ByteMultiArray based on the given JSON object.
static ByteMultiArray	fromJsonString(String jsonString) Create a new ByteMultiArray based on the given JSON string.
static ByteMultiArray	fromMessage(Message m) Create a new ByteMultiArray based on the given Message.
byte	get(int index) Get the data value at the given index.
byte[]	getData() Get the data array.
MultiArrayLayout	getLayout() Get the layout value of this ByteMultiArray.
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

ByteMultiArray

public ByteMultiArray()

Create a new, empty ByteMultiArray.

ByteMultiArray

public ByteMultiArray(MultiArrayLayout layout,
              byte[] data)

Create a new ByteMultiArray 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 ByteMultiArray.

Returns:

The layout value of this ByteMultiArray.

size

public int size()

Get the size of the array.

Returns:

The size of the array.

get

public byte 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 byte[] getData()

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

Returns:

The data array.

clone

public ByteMultiArray clone()

Create a clone of this ByteMultiArray.

Overrides:

clone in class Message

fromJsonString

public static ByteMultiArray fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A ByteMultiArray message based on the given JSON string.

fromMessage

public static ByteMultiArray fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A ByteMultiArray message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A ByteMultiArray message based on the given JSON object.