edu.wpi.rail.jrosbridge.messages.std

Class MultiArrayDimension

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.std.MultiArrayDimension

public class MultiArrayDimension
extends Message

The std_msgs/MultiArrayDimension message.

Version:

April 1, 2014

Author:

Russell Toris -- rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_LABEL The name of the label field for the message.
static String	FIELD_SIZE The name of the size field for the message.
static String	FIELD_STRIDE The name of the stride 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
MultiArrayDimension() Create a new MultiArrayDimension with all empty values.
MultiArrayDimension(String label, int size, int stride) Create a new MultiArrayDimension with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
MultiArrayDimension	clone() Create a clone of this MultiArrayDimension.
static MultiArrayDimension	fromJsonObject(javax.json.JsonObject jsonObject) Create a new MultiArrayDimension based on the given JSON object.
static MultiArrayDimension	fromJsonString(String jsonString) Create a new MultiArrayDimension based on the given JSON string.
static MultiArrayDimension	fromMessage(Message m) Create a new MultiArrayDimension based on the given Message.
String	getLabel() Get the label value of this message.
int	getSize() Get the size value of this message which should be treated as an unsigned 32-bit integer.
int	getStride() Get the stride value of this message which should be treated as an unsigned 32-bit integer.

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_LABEL

public static final String FIELD_LABEL

The name of the label field for the message.

See Also:

Constant Field Values

FIELD_SIZE

public static final String FIELD_SIZE

The name of the size field for the message.

See Also:

Constant Field Values

FIELD_STRIDE

public static final String FIELD_STRIDE

The name of the stride 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

MultiArrayDimension

public MultiArrayDimension()

Create a new MultiArrayDimension with all empty values.

MultiArrayDimension

public MultiArrayDimension(String label,
                   int size,
                   int stride)

Create a new MultiArrayDimension with the given values.

Parameters:

label - The label of given dimension.

size - The size of given dimension (in type units) treated as an unsigned 32-bit integer.

stride - The stride of given dimension treated as an unsigned 32-bit integer.

Method Detail

getLabel

public String getLabel()

Get the label value of this message.

Returns:

The label value of this message.

getSize

public int getSize()

Get the size value of this message which should be treated as an unsigned 32-bit integer.

Returns:

The size value of this message.

getStride

public int getStride()

Get the stride value of this message which should be treated as an unsigned 32-bit integer.

Returns:

The stride value of this message.

clone

public MultiArrayDimension clone()

Create a clone of this MultiArrayDimension.

Overrides:

clone in class Message

fromJsonString

public static MultiArrayDimension fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A MultiArrayDimension message based on the given JSON string.

fromMessage

public static MultiArrayDimension fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A MultiArrayDimension message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A MultiArrayDimension message based on the given JSON object.