edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room Class Reference

Inheritance diagram for edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room:

List of all members.

Public Member Functions
Room	clone ()
double	getHeight ()
String	getName ()
Pose	getPose ()
Surface[]	getSurfaces ()
double	getWidth ()
	Room ()
	Room (String name, double width, double height, Pose pose, Surface[] surfaces)
Static Public Member Functions
static Room	fromJsonObject (JsonObject jsonObject)
static Room	fromJsonString (String jsonString)
static Room	fromMessage (Message m)
Static Public Attributes
static final String	FIELD_HEIGHT = "height"
static final String	FIELD_NAME = "name"
static final String	FIELD_POSE = "pose"
static final String	FIELD_SURFACES = "surfaces"
static final String	FIELD_WIDTH = "width"
static final String	TYPE = "interactive_world_msgs/Room"
Package Attributes
final double	height
Private Attributes
final String	name
final Pose	pose
final Surface[]	surfaces
final double	width

---

Detailed Description

The interactive_world_msgs/Room message.

Author:

Russell Toris -- rctoris@wpi.edu

Version:

December 2, 2014

Definition at line 18 of file Room.java.

---

Constructor & Destructor Documentation

edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.Room

(

)

[inline]

Create a new empty Room message.

Definition at line 58 of file Room.java.

edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.Room	(	String	name,
		double	width,
		double	height,
		Pose	pose,
		Surface[]	surfaces
	)		[inline]

Create a new Room message based on the given information.

Parameters:

name	The name of the Room.
width	The width of the Room.
height	The height of the Room.
pose	The pose of the Room.
surfaces	The surfaces of the Room.

Definition at line 76 of file Room.java.

---

Member Function Documentation

Room edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.clone

(

)

[inline]

Create a clone of this Placement.

Definition at line 139 of file Room.java.

static Room edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.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:

jsonObject

The JSON object to parse.

Returns:

A Point message based on the given JSON object.

Definition at line 177 of file Room.java.

static Room edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.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:

jsonString

The JSON string to parse.

Returns:

A Point message based on the given JSON string.

Definition at line 151 of file Room.java.

static Room edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.fromMessage

(

Message

m

)

[inline, static]

Create a new Placement 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.

Definition at line 164 of file Room.java.

double edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.getHeight

(

)

[inline]

Get the height value of this Room.

Returns:

The height value of this Room.

Definition at line 113 of file Room.java.

String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.getName

(

)

[inline]

Get the name value of this Room.

Returns:

The name value of this Room.

Definition at line 95 of file Room.java.

Pose edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.getPose

(

)

[inline]

Get the pose value of this Room.

Returns:

The pose value of this Room.

Definition at line 122 of file Room.java.

Surface [] edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.getSurfaces

(

)

[inline]

Get the surfaces value of this Room.

Returns:

The surfaces value of this Room.

Definition at line 131 of file Room.java.

double edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.getWidth

(

)

[inline]

Get the width value of this Room.

Returns:

The width value of this Room.

Definition at line 104 of file Room.java.

---

Member Data Documentation

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.FIELD_HEIGHT = "height" [static]

The name of the height field for the message.

Definition at line 33 of file Room.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.FIELD_NAME = "name" [static]

The name of the name field for the message.

Definition at line 23 of file Room.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.FIELD_POSE = "pose" [static]

The name of the pose field for the message.

Definition at line 38 of file Room.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.FIELD_SURFACES = "surfaces" [static]

The name of the POI field for the message.

Definition at line 43 of file Room.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.FIELD_WIDTH = "width" [static]

The name of the width field for the message.

Definition at line 28 of file Room.java.

final double edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.height [package]

Definition at line 51 of file Room.java.

final String edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.name [private]

Definition at line 50 of file Room.java.

final Pose edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.pose [private]

Definition at line 52 of file Room.java.

final Surface [] edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.surfaces [private]

Definition at line 53 of file Room.java.

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

The message type.

Definition at line 48 of file Room.java.

final double edu.wpi.rail.jinteractiveworld.ros.msgs.interactiveworldmsgs.Room.width [private]

Definition at line 51 of file Room.java.

---

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

• Room.java