edu.wpi.rail.jrosbridge.messages.geometry

Class Point

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.Point

public class Point
extends Message

The geometry_msgs/Point message. This contains the position of a point in free space.

Version:

April 1, 2014

Author:

Russell Toris -- rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
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
Point() Create a new Point with all 0s.
Point(double x, double y, double z) Create a new Point with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
Point	clone() Create a clone of this Point.
static Point	fromJsonObject(javax.json.JsonObject jsonObject) Create a new Point based on the given JSON object.
static Point	fromJsonString(String jsonString) Create a new Point based on the given JSON string.
static Point	fromMessage(Message m) Create a new Point based on the given Message.
double	getX() Get the x value of this point.
double	getY() Get the y value of this point.
double	getZ() Get the z 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_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

TYPE

public static final String TYPE

The message type.

See Also:

Constant Field Values

Constructor Detail

Point

public Point()

Create a new Point with all 0s.

Point

public Point(double x,
     double y,
     double z)

Create a new Point with the given values.

Parameters:

x - The x value of the point.

y - The y value of the point.

z - The z value of the point.

Method Detail

getX

public double getX()

Get the x value of this point.

Returns:

The x value of this point.

getY

public double getY()

Get the y value of this point.

Returns:

The y value of this point.

getZ

public double getZ()

Get the z value of this point.

Returns:

The z value of this point.

clone

public Point clone()

Create a clone of this Point.

Overrides:

clone in class Message

fromJsonString

public static Point fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A Point message based on the given JSON string.

fromMessage

public static Point fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A Point message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A Point message based on the given JSON object.