edu.wpi.rail.jrosbridge.messages.actionlib

Class GoalStatusArray

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.actionlib.GoalStatusArray

public class GoalStatusArray
extends Message

The actionlib_msgs/GoalStatusArray message. Stores the statuses for goals that are currently being tracked by an action server.

Version:

April 1, 2014

Author:

Russell Toris -- rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_HEADER The name of the header field for the message.
static String	FIELD_STATUS_LIST The name of the status list 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
GoalStatusArray() Create a new, empty GoalStatusArray.
GoalStatusArray(Header header, GoalStatus[] statusList) Create a new GoalStatusArray with the given set of statuses and header.

Method Summary

Methods

Modifier and Type	Method and Description
GoalStatusArray	clone() Create a clone of this GoalStatusArray.
static GoalStatusArray	fromJsonObject(javax.json.JsonObject jsonObject) Create a new GoalStatusArray based on the given JSON object.
static GoalStatusArray	fromJsonString(String jsonString) Create a new GoalStatusArray based on the given JSON string.
static GoalStatusArray	fromMessage(Message m) Create a new GoalStatusArray based on the given Message.
GoalStatus	get(int index) Get the status in the status array at the given index.
Header	getHeader() Get the header value of this status array.
GoalStatus[]	getStatusList() Get the statuses of this status array.
int	size() Get the number of statuses in this status 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_HEADER

public static final String FIELD_HEADER

The name of the header field for the message.

See Also:

Constant Field Values

FIELD_STATUS_LIST

public static final String FIELD_STATUS_LIST

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

GoalStatusArray

public GoalStatusArray()

Create a new, empty GoalStatusArray.

GoalStatusArray

public GoalStatusArray(Header header,
               GoalStatus[] statusList)

Create a new GoalStatusArray with the given set of statuses and header. The array of statuses will be copied into this object.

Parameters:

header - The message header.

statusList - The statuses of the status array.

Method Detail

size

public int size()

Get the number of statuses in this status array.

Returns:

The number of statuses in this status array.

get

public GoalStatus get(int index)

Get the status in the status array at the given index.

Parameters:

index - The index to get the status of.

Returns:

The status at the given index.

getStatusList

public GoalStatus[] getStatusList()

Get the statuses of this status array. Note that this array should never be modified directly.

Returns:

The statuses of this status array.

getHeader

public Header getHeader()

Get the header value of this status array.

Returns:

The statuses header value of this status array.

clone

public GoalStatusArray clone()

Create a clone of this GoalStatusArray.

Overrides:

clone in class Message

fromJsonString

public static GoalStatusArray fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A GoalStatusArray message based on the given JSON string.

fromMessage

public static GoalStatusArray fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A GoalStatusArray message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A GoalStatusArray message based on the given JSON object.