edu.wpi.rail.jrosbridge.messages.geometry

Class PoseStamped

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.PoseStamped

public class PoseStamped
extends Message

The geometry_msgs/PoseStamped message. A Pose with reference coordinate frame and timestamp.

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_POSE The name of the pose 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
PoseStamped() Create a new PoseStamped with all 0s.
PoseStamped(Header header, Pose pose) Create a new PoseStamped with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
PoseStamped	clone() Create a clone of this PoseStamped.
static PoseStamped	fromJsonObject(javax.json.JsonObject jsonObject) Create a new PoseStamped based on the given JSON object.
static PoseStamped	fromJsonString(String jsonString) Create a new PoseStamped based on the given JSON string.
static PoseStamped	fromMessage(Message m) Create a new PoseStamped based on the given Message.
Header	getHeader() Get the header value of this pose.
Pose	getPose() Get the pose value of this pose.

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_POSE

public static final String FIELD_POSE

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

PoseStamped

public PoseStamped()

Create a new PoseStamped with all 0s.

PoseStamped

public PoseStamped(Header header,
           Pose pose)

Create a new PoseStamped with the given values.

Parameters:

header - The header value of the pose.

pose - The pose value of the pose.

Method Detail

getHeader

public Header getHeader()

Get the header value of this pose.

Returns:

The header value of this pose.

getPose

public Pose getPose()

Get the pose value of this pose.

Returns:

The pose value of this pose.

clone

public PoseStamped clone()

Create a clone of this PoseStamped.

Overrides:

clone in class Message

fromJsonString

public static PoseStamped fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A PoseStamped message based on the given JSON string.

fromMessage

public static PoseStamped fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A PoseStamped message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A PoseStamped message based on the given JSON object.