edu.wpi.rail.jrosbridge.messages.geometry

Class PolygonStamped

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.geometry.PolygonStamped

public class PolygonStamped
extends Message

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

Method Summary

Methods

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

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_POLYGON

public static final String FIELD_POLYGON

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

PolygonStamped

public PolygonStamped()

Create a new PolygonStamped with all 0s.

PolygonStamped

public PolygonStamped(Header header,
              Polygon polygon)

Create a new PolygonStamped with the given values.

Parameters:

header - The header value of the polygon.

polygon - The polygon value of the polygon.

Method Detail

getHeader

public Header getHeader()

Get the header value of this polygon.

Returns:

The header value of this polygon.

getPolygon

public Polygon getPolygon()

Get the polygon value of this polygon.

Returns:

The polygon value of this polygon.

clone

public PolygonStamped clone()

Create a clone of this PolygonStamped.

Overrides:

clone in class Message

fromJsonString

public static PolygonStamped fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A PolygonStamped message based on the given JSON string.

fromMessage

public static PolygonStamped fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A PolygonStamped message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A PolygonStamped message based on the given JSON object.