Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement Class Reference
Inheritance diagram for edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Placement clone ()
Item getItem ()
Point getPosition ()
String getReferenceFrameId ()
Room getRoom ()
double getRotation ()
Surface getSurface ()
 Placement ()
 Placement (Item item, Room room, Surface surface, String referenceFrameId, Point position, double rotation)

Static Public Member Functions

static Placement fromJsonObject (JsonObject jsonObject)
static Placement fromJsonString (String jsonString)
static Placement fromMessage (Message m)

Static Public Attributes

static final String FIELD_ITEM = "item"
static final String FIELD_POSITION = "position"
static final String FIELD_REFERENCE_FRAME_ID = "reference_frame_id"
static final String FIELD_ROOM = "room"
static final String FIELD_ROTATION = "rotation"
static final String FIELD_SURFACE = "surface"
static final String TYPE = "interactive_world_msgs/Placement"

Private Attributes

final Item item
final Point position
final String referenceFrameId
final Room room
final double rotation
final Surface surface

Detailed Description

The interactive_world_msgs/Placement message.

Author:
Russell Toris -- rctoris@wpi.edu
Version:
December 2, 2014

Definition at line 19 of file Placement.java.

Constructor & Destructor Documentation

edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.Placement ( ) [inline]

Create a new empty Placement message.

Definition at line 66 of file Placement.java.

edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.Placement ( Item  item,
Room  room,
Surface  surface,
String  referenceFrameId,
Point  position,
double  rotation 
) [inline]

Create a new Placement message based on the given information.

Parameters:
itemThe item of the Placement.
roomThe room of the Placement.
surfaceThe surface of the Placement.
referenceFrameIdThe reference frame of the Placement.
positionThe position frame of the Placement.
rotationThe rotation of the Placement.

Definition at line 86 of file Placement.java.

Member Function Documentation

Placement edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.clone ( ) [inline]

Create a clone of this Placement.

Definition at line 160 of file Placement.java.

static Placement edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.fromJsonObject ( JsonObject  jsonObject) [inline, static]

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

Parameters:
jsonObjectThe JSON object to parse.
Returns:
A Point message based on the given JSON object.

Definition at line 198 of file Placement.java.

static Placement edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.fromJsonString ( String  jsonString) [inline, static]

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

Parameters:
jsonStringThe JSON string to parse.
Returns:
A Point message based on the given JSON string.

Definition at line 172 of file Placement.java.

static Placement edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.fromMessage ( Message  m) [inline, static]

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

Parameters:
mThe Message to parse.
Returns:
A Point message based on the given Message.

Definition at line 185 of file Placement.java.

Item edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.getItem ( ) [inline]

Get the item value of this Placement.

Returns:
The item value of this Placement.

Definition at line 107 of file Placement.java.

Point edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.getPosition ( ) [inline]

Get the position value of this Placement.

Returns:
The position value of this Placement.

Definition at line 143 of file Placement.java.

String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.getReferenceFrameId ( ) [inline]

Get the reference frame value of this Placement.

Returns:
The reference frame value of this Placement.

Definition at line 134 of file Placement.java.

Room edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.getRoom ( ) [inline]

Get the room value of this Placement.

Returns:
The room value of this Placement.

Definition at line 116 of file Placement.java.

double edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.getRotation ( ) [inline]

Get the rotation value of this Placement.

Returns:
The rotation value of this Placement.

Definition at line 152 of file Placement.java.

Surface edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.getSurface ( ) [inline]

Get the surface value of this Placement.

Returns:
The surface value of this Placement.

Definition at line 125 of file Placement.java.

Member Data Documentation

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.FIELD_ITEM = "item" [static]

The name of the item field for the message.

Definition at line 24 of file Placement.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.FIELD_POSITION = "position" [static]

The name of the position field for the message.

Definition at line 44 of file Placement.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.FIELD_REFERENCE_FRAME_ID = "reference_frame_id" [static]

The name of the reference frame field for the message.

Definition at line 39 of file Placement.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.FIELD_ROOM = "room" [static]

The name of the room field for the message.

Definition at line 29 of file Placement.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.FIELD_ROTATION = "rotation" [static]

The name of the rotation field for the message.

Definition at line 49 of file Placement.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.FIELD_SURFACE = "surface" [static]

The name of the surface field for the message.

Definition at line 34 of file Placement.java.

final Item edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.item [private]

Definition at line 56 of file Placement.java.

final Point edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.position [private]

Definition at line 60 of file Placement.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.referenceFrameId [private]

Definition at line 59 of file Placement.java.

final Room edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.room [private]

Definition at line 57 of file Placement.java.

final double edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.rotation [private]

Definition at line 61 of file Placement.java.

final Surface edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.surface [private]

Definition at line 58 of file Placement.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Placement.TYPE = "interactive_world_msgs/Placement" [static]

The message type.

Definition at line 54 of file Placement.java.

The documentation for this class was generated from the following file:

jinteractiveworld
Author(s): Russell Toris
autogenerated on Thu Jun 6 2019 21:34:23