edu.wpi.rail.jrosbridge.messages.geometry

Class TwistStamped

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.TwistStamped

public class TwistStamped
extends Message

The geometry_msgs/TwistStamped message. A twist 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_TWIST The name of the twist 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
TwistStamped() Create a new TwistStamped with all 0s.
TwistStamped(Header header, Twist twist) Create a new TwistStamped with the given values.

Method Summary

Methods

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

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_TWIST

public static final String FIELD_TWIST

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

TwistStamped

public TwistStamped()

Create a new TwistStamped with all 0s.

TwistStamped

public TwistStamped(Header header,
            Twist twist)

Create a new TwistStamped with the given values.

Parameters:

header - The header value of the twist.

twist - The twist value of the twist.

Method Detail

getHeader

public Header getHeader()

Get the header value of this twist.

Returns:

The header value of this twist.

getTwist

public Twist getTwist()

Get the twist value of this twist.

Returns:

The twist value of this twist.

clone

public TwistStamped clone()

Create a clone of this TwistStamped.

Overrides:

clone in class Message

fromJsonString

public static TwistStamped fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A TwistStamped message based on the given JSON string.

fromMessage

public static TwistStamped fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A TwistStamped message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A TwistStamped message based on the given JSON object.