rail::spatial_temporal_learning::worldlib::world::Placement Class Reference

World placement configuration information. More...

#include <Placement.h>

List of all members.

Public Member Functions
const Item &	getItem () const
	Item value accessor (immutable).
Item &	getItem ()
	Item value accessor.
const Object &	getObject () const
	Object value accessor (immutable).
Object &	getObject ()
	Object value accessor.
const Surface &	getSurface () const
	Surface value accessor (immutable).
Surface &	getSurface ()
	Surface value accessor.
	Placement (const Item &item, const Object &object, const Surface &pose)
	Create a new Placement.
void	setItem (const Item &item)
	Item value mutator.
void	setObject (const Object &object)
	Object value mutator.
void	setSurface (const Surface &surface)
	Surface value mutator.
Private Attributes
Item	item_
Object	object_
Surface	surface_

---

Detailed Description

World placement configuration information.

A placement consists of an Item with respect to some Object at a given Pose on a Surface.

Definition at line 33 of file Placement.h.

---

Constructor & Destructor Documentation

Placement::Placement	(	const Item &	item,
		const Object &	object,
		const Surface &	pose
	)

Create a new Placement.

Create a new Placement with the given Item (with a Pose in reference to the Object), the reference Object, and the Surface it was placed on.

Parameters:

item	The Item seen in this Placement (the Pose of the Item should be in reference to the Object).
object	The Object the Item was placed in reference to.
pose	The Pose of the Item in with respect to the Object.

Definition at line 17 of file Placement.cpp.

---

Member Function Documentation

const Item & Placement::getItem

(

)

const

Item value accessor (immutable).

Get the Item value of this Placement.

Returns:

The Item value of this Placement.

Definition at line 22 of file Placement.cpp.

Item & Placement::getItem

(

)

Item value accessor.

Get the Item value of this Placement.

Returns:

The Item value of this Placement.

Definition at line 27 of file Placement.cpp.

const Object & Placement::getObject

(

)

const

Object value accessor (immutable).

Get the Object value of this Placement.

Returns:

The Object value of this Placement.

Definition at line 37 of file Placement.cpp.

Object & Placement::getObject

(

)

Object value accessor.

Get the Object value of this Placement.

Returns:

The Object value of this Placement.

Definition at line 42 of file Placement.cpp.

const Surface & Placement::getSurface

(

)

const

Surface value accessor (immutable).

Get the Surface value of this Placement.

Returns:

The Surface value of this Placement.

Definition at line 52 of file Placement.cpp.

Surface & Placement::getSurface

(

)

Surface value accessor.

Get the Surface value of this Placement.

Returns:

The Surface value of this Placement.

Definition at line 57 of file Placement.cpp.

void Placement::setItem

(

const Item &

item

)

Item value mutator.

Set the Item value of this Placement.

Parameters:

item	The new Item value of this Placement.

Definition at line 32 of file Placement.cpp.

void Placement::setObject

(

const Object &

object

)

Object value mutator.

Set the Object value of this Placement.

Parameters:

object

The new Object value of this Placement.

Definition at line 47 of file Placement.cpp.

void Placement::setSurface

(

const Surface &

surface

)

Surface value mutator.

Set the Surface value of this Placement.

Parameters:

surface

The new Surface value of this Placement.

Definition at line 62 of file Placement.cpp.

---

Member Data Documentation

Item rail::spatial_temporal_learning::worldlib::world::Placement::item_ [private]

The Item in this Placement.

Definition at line 131 of file Placement.h.

Object rail::spatial_temporal_learning::worldlib::world::Placement::object_ [private]

The Object in this Placement.

Definition at line 133 of file Placement.h.

Surface rail::spatial_temporal_learning::worldlib::world::Placement::surface_ [private]

The Surface in this Placement.

Definition at line 135 of file Placement.h.

---

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

• Placement.h
• Placement.cpp