edu.wpi.rail.jrosbridge.messages.geometry

Class PointStamped

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.PointStamped

public class PointStamped
extends Message

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

Method Summary

Methods

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

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_POINT

public static final String FIELD_POINT

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

PointStamped

public PointStamped()

Create a new PointStamped with all 0s.

PointStamped

public PointStamped(Header header,
            Point point)

Create a new PointStamped with the given values.

Parameters:

header - The header value of the point.

point - The point value of the point.

Method Detail

getHeader

public Header getHeader()

Get the header value of this point.

Returns:

The header value of this point.

getPoint

public Point getPoint()

Get the point value of this point.

Returns:

The point value of this point.

clone

public PointStamped clone()

Create a clone of this PointStamped.

Overrides:

clone in class Message

fromJsonString

public static PointStamped fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A PointStamped message based on the given JSON string.

fromMessage

public static PointStamped fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A PointStamped message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A PointStamped message based on the given JSON object.