edu.wpi.rail.jrosbridge.messages.geometry

Class Pose2D

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.Pose2D

public class Pose2D
extends Message

The geometry_msgs/Pose2D message. This expresses a position and orientation on a 2D manifold.

Version:

April 1, 2014

Author:

Russell Toris -- rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_THETA The name of the theta field for the message.
static String	FIELD_X The name of the x field for the message.
static String	FIELD_Y The name of the y 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
Pose2D() Create a new Pose2D with all 0s.
Pose2D(double x, double y, double theta) Create a new Pose2D with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
Pose2D	clone() Create a clone of this Pose2D.
static Pose2D	fromJsonObject(javax.json.JsonObject jsonObject) Create a new Pose2D based on the given JSON object.
static Pose2D	fromJsonString(String jsonString) Create a new Pose2D based on the given JSON string.
static Pose2D	fromMessage(Message m) Create a new Pose2D based on the given Message.
double	getTheta() Get the theta value of this pose.
double	getX() Get the x value of this pose.
double	getY() Get the y 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_X

public static final String FIELD_X

The name of the x field for the message.

See Also:

Constant Field Values

FIELD_Y

public static final String FIELD_Y

The name of the y field for the message.

See Also:

Constant Field Values

FIELD_THETA

public static final String FIELD_THETA

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

Pose2D

public Pose2D()

Create a new Pose2D with all 0s.

Pose2D

public Pose2D(double x,
      double y,
      double theta)

Create a new Pose2D with the given values.

Parameters:

x - The x value of the pose.

y - The y value of the pose.

theta - The theta value of the pose.

Method Detail

getX

public double getX()

Get the x value of this pose.

Returns:

The x value of this pose.

getY

public double getY()

Get the y value of this pose.

Returns:

The y value of this pose.

getTheta

public double getTheta()

Get the theta value of this pose.

Returns:

The theta value of this pose.

clone

public Pose2D clone()

Create a clone of this Pose2D.

Overrides:

clone in class Message

fromJsonString

public static Pose2D fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A Pose2D message based on the given JSON string.

fromMessage

public static Pose2D fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A Pose2D message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A Pose2D message based on the given JSON object.