edu.wpi.rail.jrosbridge.messages.geometry

Class WrenchStamped

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.WrenchStamped

public class WrenchStamped
extends Message

The geometry_msgs/WrenchStamped message. A wrench 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_WRENCH The name of the wrench 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
WrenchStamped() Create a new WrenchStamped with all 0s.
WrenchStamped(Header header, Wrench wrench) Create a new WrenchStamped with the given values.

Method Summary

Methods

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

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_WRENCH

public static final String FIELD_WRENCH

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

WrenchStamped

public WrenchStamped()

Create a new WrenchStamped with all 0s.

WrenchStamped

public WrenchStamped(Header header,
             Wrench wrench)

Create a new WrenchStamped with the given values.

Parameters:

header - The header value of the wrench.

wrench - The wrench value of the wrench.

Method Detail

getHeader

public Header getHeader()

Get the header value of this wrench.

Returns:

The header value of this wrench.

getWrench

public Wrench getWrench()

Get the wrench value of this wrench.

Returns:

The wrench value of this wrench.

clone

public WrenchStamped clone()

Create a clone of this WrenchStamped.

Overrides:

clone in class Message

fromJsonString

public static WrenchStamped fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A WrenchStamped message based on the given JSON string.

fromMessage

public static WrenchStamped fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A WrenchStamped message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A WrenchStamped message based on the given JSON object.