edu.wpi.rail.jrosbridge.messages

Class Message

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

Direct Known Subclasses:

Bool, Byte, ByteMultiArray, Char, ColorRGBA, Duration, Empty, Float32, Float32MultiArray, Float64, Float64MultiArray, GoalID, GoalStatus, GoalStatusArray, Header, Int16, Int16MultiArray, Int32, Int32MultiArray, Int64, Int64MultiArray, Int8, Int8MultiArray, MultiArrayDimension, MultiArrayLayout, Point, Point32, PointStamped, Polygon, PolygonStamped, Pose, Pose2D, PoseArray, PoseStamped, PoseWithCovariance, PoseWithCovarianceStamped, Quaternion, QuaternionStamped, String, Time, Transform, TransformStamped, Twist, TwistStamped, TwistWithCovariance, TwistWithCovarianceStamped, UInt16, UInt16MultiArray, UInt32, UInt32MultiArray, UInt64, UInt64MultiArray, UInt8, UInt8MultiArray, Vector3, Vector3Stamped, Wrench, WrenchStamped

public class Message
extends JsonWrapper

Message objects are used for publishing and subscribing to and from topics. These messages act as wrappers around JSON objects. Message data is immutable.

Version:

April 1, 2014

Author:

Russell Toris - rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_MESSAGE The String representation of an empty message in JSON.

Fields inherited from class edu.wpi.rail.jrosbridge.JsonWrapper

EMPTY_JSON

Constructor Summary

Constructors

Constructor and Description
Message() Create a new, empty message.
Message(javax.json.JsonObject jsonObject) Create a Message based on the given JSON object.
Message(javax.json.JsonObject jsonObject, String messageType) Create a Message based on the given JSON object.
Message(String jsonString) Create a Message based on the given String representation of a JSON object.
Message(String jsonString, String messageType) Create a Message based on the given String representation of a JSON object.

Method Summary

Methods

Modifier and Type	Method and Description
Message	clone() Create a clone of this Message.
String	getMessageType() Get the type of the message if one was set.
void	setMessageType(String messageType) Set the type of the message.

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

EMPTY_MESSAGE

public static final String EMPTY_MESSAGE

The String representation of an empty message in JSON.

See Also:

Constant Field Values

Constructor Detail

Message

public Message()

Create a new, empty message. The type will be set to the empty string.

Message

public Message(String jsonString)

Create a Message based on the given String representation of a JSON object. The type will be set to the empty string.

Parameters:

jsonString - The JSON String to parse.

Message

public Message(String jsonString,
       String messageType)

Create a Message based on the given String representation of a JSON object.

Parameters:

jsonString - The JSON String to parse.

messageType - The type of the message (e.g., "geometry_msgs/Twist").

Message

public Message(javax.json.JsonObject jsonObject)

Create a Message based on the given JSON object. The type will be set to the empty string.

Parameters:

jsonObject - The JSON object containing the message data.

Message

public Message(javax.json.JsonObject jsonObject,
       String messageType)

Create a Message based on the given JSON object.

Parameters:

jsonObject - The JSON object containing the message data.

messageType - The type of the message (e.g., "geometry_msgs/Twist").

Method Detail

getMessageType

public String getMessageType()

Get the type of the message if one was set.

Returns:

The type of the message.

setMessageType

public void setMessageType(String messageType)

Set the type of the message.

Parameters:

messageType - The type of the message (e.g., "geometry_msgs/Twist").

clone

public Message clone()

Create a clone of this Message.

Specified by:

clone in class JsonWrapper