edu.wpi.rail.jrosbridge.messages.std

Class Header

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.messages.Message

edu.wpi.rail.jrosbridge.messages.std.Header

public class Header
extends Message

The std_msgs/Header message. Standard metadata for higher-level stamped data types. This is generally used to communicate timestamped data in a particular coordinate frame.

Version:

April 1, 2014

Author:

Russell Toris -- rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_FRAME_ID The name of the frame ID field for the message.
static String	FIELD_SEQ The name of the sequence field for the message.
static String	FIELD_STAMP The name of the timestamp 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
Header() Create a new Header with all empty values.
Header(int seq, Time stamp, String frameID) Create a new Header with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
Header	clone() Create a clone of this Header.
static Header	fromJsonObject(javax.json.JsonObject jsonObject) Create a new Header based on the given JSON object.
static Header	fromJsonString(String jsonString) Create a new Header based on the given JSON string.
static Header	fromMessage(Message m) Create a new Header based on the given Message.
String	getFrameID() Get the frame ID value of this header.
int	getSeq() Get the sequence value of this header which should be treated as an unsigned 32-bit integer.
Time	getStamp() Get the timestamp value of this header.

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_SEQ

public static final String FIELD_SEQ

The name of the sequence field for the message.

See Also:

Constant Field Values

FIELD_STAMP

public static final String FIELD_STAMP

The name of the timestamp field for the message.

See Also:

Constant Field Values

FIELD_FRAME_ID

public static final String FIELD_FRAME_ID

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

Header

public Header()

Create a new Header with all empty values.

Header

public Header(int seq,
      Time stamp,
      String frameID)

Create a new Header with the given values.

Parameters:

seq - The sequence number treated as an unsigned 32-bit integer.

stamp - The timestamp.

frameID - The frame ID.

Method Detail

getSeq

public int getSeq()

Get the sequence value of this header which should be treated as an unsigned 32-bit integer.

Returns:

The sequence value of this header.

getStamp

public Time getStamp()

Get the timestamp value of this header.

Returns:

The timestamp value of this header.

getFrameID

public String getFrameID()

Get the frame ID value of this header.

Returns:

The frame ID value of this header.

clone

public Header clone()

Create a clone of this Header.

Overrides:

clone in class Message

fromJsonString

public static Header fromJsonString(String jsonString)

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

Parameters:

jsonString - The JSON string to parse.

Returns:

A Header message based on the given JSON string.

fromMessage

public static Header fromMessage(Message m)

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

Parameters:

m - The Message to parse.

Returns:

A Header message based on the given Message.

fromJsonObject

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

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

Parameters:

jsonObject - The JSON object to parse.

Returns:

A Header message based on the given JSON object.