edu.wpi.rail.jrosbridge.messages.geometry

Class Quaternion

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.Quaternion

public class Quaternion
extends Message

The geometry_msgs/Quaternion message. This represents an orientation in free space in quaternion form.

Version:

April 1, 2014

Author:

Russell Toris -- rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_W The name of the z 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	FIELD_Z The name of the z 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
Quaternion() Create a new Quaternion with all 0s.
Quaternion(double x, double y, double z, double w) Create a new quaternion with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
Quaternion	clone() Create a clone of this Quaternion.
static Quaternion	fromJsonObject(javax.json.JsonObject jsonObject) Create a new Quaternion based on the given JSON object.
static Quaternion	fromJsonString(String jsonString) Create a new Quaternion based on the given JSON string.
static Quaternion	fromMessage(Message m) Create a new Quaternion based on the given Message.
double	getW() Get the w value of this quaternion.
double	getX() Get the x value of this quaternion.
double	getY() Get the y value of this quaternion.
double	getZ() Get the z value of this quaternion.

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_Z

public static final String FIELD_Z

The name of the z field for the message.

See Also:

Constant Field Values

FIELD_W

public static final String FIELD_W

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

Quaternion

public Quaternion()

Create a new Quaternion with all 0s.

Quaternion

public Quaternion(double x,
          double y,
          double z,
          double w)

Create a new quaternion with the given values.

Parameters:

x - The x value of the quaternion.

y - The y value of the quaternion.

z - The z value of the quaternion.

w - The w value of the quaternion.

Method Detail

getX

public double getX()

Get the x value of this quaternion.

Returns:

The x value of this quaternion.

getY

public double getY()

Get the y value of this quaternion.

Returns:

The y value of this quaternion.

getZ

public double getZ()

Get the z value of this quaternion.

Returns:

The z value of this quaternion.

getW

public double getW()

Get the w value of this quaternion.

Returns:

The w value of this quaternion.

clone

public Quaternion clone()

Create a clone of this Quaternion.

Overrides:

clone in class Message

fromJsonString

public static Quaternion fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A Quaternion message based on the given JSON string.

fromMessage

public static Quaternion fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A Quaternion message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A Quaternion message based on the given JSON object.