edu.wpi.rail.jrosbridge.messages.geometry

Class QuaternionStamped

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.QuaternionStamped

public class QuaternionStamped
extends Message

The geometry_msgs/QuaternionStamped message. This represents a Quaternion 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_QUATERNION The name of the quaternion 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
QuaternionStamped() Create a new QuaternionStamped with all 0s.
QuaternionStamped(Header header, Quaternion quaternion) Create a new QuaternionStamped with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
QuaternionStamped	clone() Create a clone of this QuaternionStamped.
static QuaternionStamped	fromJsonObject(javax.json.JsonObject jsonObject) Create a new QuaternionStamped based on the given JSON object.
static QuaternionStamped	fromJsonString(String jsonString) Create a new QuaternionStamped based on the given JSON string.
static QuaternionStamped	fromMessage(Message m) Create a new QuaternionStamped based on the given Message.
Header	getHeader() Get the header value of this quaternion.
Quaternion	getQuaternion() Get the quaternion 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_HEADER

public static final String FIELD_HEADER

The name of the header field for the message.

See Also:

Constant Field Values

FIELD_QUATERNION

public static final String FIELD_QUATERNION

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

QuaternionStamped

public QuaternionStamped()

Create a new QuaternionStamped with all 0s.

QuaternionStamped

public QuaternionStamped(Header header,
                 Quaternion quaternion)

Create a new QuaternionStamped with the given values.

Parameters:

header - The header value of the quaternion.

quaternion - The quaternion value of the quaternion.

Method Detail

getHeader

public Header getHeader()

Get the header value of this quaternion.

Returns:

The header value of this quaternion.

getQuaternion

public Quaternion getQuaternion()

Get the quaternion value of this quaternion.

Returns:

The quaternion value of this quaternion.

clone

public QuaternionStamped clone()

Create a clone of this QuaternionStamped.

Overrides:

clone in class Message

fromJsonString

public static QuaternionStamped fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A QuaternionStamped message based on the given JSON string.

fromMessage

public static QuaternionStamped fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A QuaternionStamped message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A QuaternionStamped message based on the given JSON object.