edu.wpi.rail.jrosbridge.messages.geometry

Class PoseArray

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.PoseArray

public class PoseArray
extends Message

The geometry_msgs/PoseArray message. An array of poses with a header for global reference.

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_POSES The name of the poses 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
PoseArray() Create a new PoseArray with no poses.
PoseArray(Header header, Pose[] poses) Create a new PoseArray with the given set of poses and header.

Method Summary

Methods

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

public static final String FIELD_POSES

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

PoseArray

public PoseArray()

Create a new PoseArray with no poses.

PoseArray

public PoseArray(Header header,
         Pose[] poses)

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

Parameters:

header - The message header.

poses - The poses of the pose array.

Method Detail

size

public int size()

Get the number of poses in this pose array.

Returns:

The number of poses in this pose array.

get

public Pose get(int index)

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

Parameters:

index - The index to get the pose of.

Returns:

The pose at the given index.

getPoses

public Pose[] getPoses()

Get the poses of this pose array. Note that this array should never be modified directly.

Returns:

The poses of this pose array.

getHeader

public Header getHeader()

Get the header value of this pose array.

Returns:

The poses header value of this pose array.

clone

public PoseArray clone()

Create a clone of this PoseArray.

Overrides:

clone in class Message

fromJsonString

public static PoseArray fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A PoseArray message based on the given JSON string.

fromMessage

public static PoseArray fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A PoseArray message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A PoseArray message based on the given JSON object.