Public Member Functions | Private Attributes
rail::spatial_temporal_learning::worldlib::world::Observation Class Reference

World observation configuration information. More...

#include <Observation.h>

List of all members.

Public Member Functions

const ItemgetItem () const
 Item value accessor (immutable).
ItemgetItem ()
 Item value accessor.
const PlacementSurfacegetPlacementSurface () const
 PlacementSurface accessor.
const geometry::PosegetPose () const
 Pose value accessor (immutable).
geometry::PosegetPose ()
 Pose value accessor.
const ros::TimegetRemovedEstimate () const
 Estimated removal time value accessor (immutable).
ros::TimegetRemovedEstimate ()
 Estimated removal time value accessor.
const ros::TimegetRemovedObserved () const
 Observed removal time value accessor (immutable).
ros::TimegetRemovedObserved ()
 Observed removal time value accessor.
const SurfacegetSurface () const
 Surface value accessor (immutable).
SurfacegetSurface ()
 Surface value accessor.
const ros::TimegetTime () const
 Time value accessor (immutable).
ros::TimegetTime ()
 Time value accessor.
 Observation (const Item &item=Item(), const Surface &surface=Surface(), const geometry::Pose &pose=geometry::Pose(), const ros::Time &time=ros::Time::now(), const ros::Time &removed_estimate=ros::Time(0), const ros::Time &removed_observed=ros::Time(0))
 Create a new Observation.
void setItem (const Item &item)
 Item value mutator.
void setPose (const geometry::Pose &pose)
 Pose value mutator.
void setRemovedEstimate (const ros::Time &removed_estimate)
 Estimated removal time value mutator.
void setRemovedObserved (const ros::Time &removed_observed)
 Observed removal time value mutator.
void setSurface (const Surface &surface)
 Surface value mutator.
void setTime (const ros::Time &time)
 Time value mutator.

Private Attributes

Item item_
geometry::Pose pose_
ros::Time removed_estimate_
ros::Time removed_observed_
Surface surface_
ros::Time time_

Detailed Description

World observation configuration information.

An observation consists of seeing a given item on a given surface at a give pose.

Definition at line 38 of file Observation.h.


Constructor & Destructor Documentation

Observation::Observation ( const Item item = Item(),
const Surface surface = Surface(),
const geometry::Pose pose = geometry::Pose(),
const ros::Time time = ros::Time::now(),
const ros::Time removed_estimate = ros::Time(0),
const ros::Time removed_observed = ros::Time(0) 
)

Create a new Observation.

Create a new Observation with the given Item, Surface, and Pose (in reference to the surface itself).

Parameters:
itemThe Item seen in this Observation (defaults to empty Item).
surfaceThe Surface the Item was seen on in this Observation (defaults to empty Surface).
poseThe Pose of this Item in this Observation with respect to the Surface (defaults to empty Pose).
timeThe ros::Time the observation was made (defaults to now).
removed_estimateThe estimated ros::Time the Item was removed from the Surface (defaults to 0).
removed_observedThe observed ros::Time the Item was not seen on the Surface (defaults to 0).

Definition at line 18 of file Observation.cpp.


Member Function Documentation

const Item & Observation::getItem ( ) const

Item value accessor (immutable).

Get the Item value of this Observation.

Returns:
The Item value of this Observation.

Definition at line 25 of file Observation.cpp.

Item value accessor.

Get the Item value of this Observation.

Returns:
The Item value of this Observation.

Definition at line 30 of file Observation.cpp.

PlacementSurface accessor.

Get the PlacementSurface of this Observation (defined as the closest placement surface to the observation Pose).

Returns:
The PlacementSurface value of this Observation.

Definition at line 55 of file Observation.cpp.

const Pose & Observation::getPose ( ) const

Pose value accessor (immutable).

Get the Pose value of this Observation.

Returns:
The Pose value of this Observation.

Definition at line 60 of file Observation.cpp.

Pose value accessor.

Get the Pose value of this Observation.

Returns:
The Pose value of this Observation.

Definition at line 65 of file Observation.cpp.

Estimated removal time value accessor (immutable).

Get the estimated removal time value of this Observation.

Returns:
The estimated removal time value of this Observation.

Definition at line 90 of file Observation.cpp.

Estimated removal time value accessor.

Get the estimated removal time value of this Observation.

Returns:
The estimated removal time value of this Observation.

Definition at line 95 of file Observation.cpp.

Observed removal time value accessor (immutable).

Get the observed removal time value of this Observation.

Returns:
The observed removal time value of this Observation.

Definition at line 105 of file Observation.cpp.

Observed removal time value accessor.

Get the observed removal time value of this Observation.

Returns:
The observed removal time value of this Observation.

Definition at line 110 of file Observation.cpp.

const Surface & Observation::getSurface ( ) const

Surface value accessor (immutable).

Get the Surface value of this Observation.

Returns:
The Surface value of this Observation.

Definition at line 40 of file Observation.cpp.

Surface value accessor.

Get the Surface value of this Observation.

Returns:
The Surface value of this Observation.

Definition at line 45 of file Observation.cpp.

const ros::Time & Observation::getTime ( ) const

Time value accessor (immutable).

Get the time value of this Observation.

Returns:
The time value of this Observation.

Definition at line 75 of file Observation.cpp.

Time value accessor.

Get the time value of this Observation.

Returns:
The time value of this Observation.

Definition at line 80 of file Observation.cpp.

void Observation::setItem ( const Item item)

Item value mutator.

Set the Item value of this Observation.

Parameters:
itemThe new Item value of this Observation.

Definition at line 35 of file Observation.cpp.

void Observation::setPose ( const geometry::Pose pose)

Pose value mutator.

Set the Pose value of this Observation.

Parameters:
poseThe new Pose value of this Observation.

Definition at line 70 of file Observation.cpp.

void Observation::setRemovedEstimate ( const ros::Time removed_estimate)

Estimated removal time value mutator.

Set the estimated removal time value of this Observation.

Parameters:
timeThe new estimated removal time value of this Observation.

Definition at line 100 of file Observation.cpp.

void Observation::setRemovedObserved ( const ros::Time removed_observed)

Observed removal time value mutator.

Set the observed removal time value of this Observation.

Parameters:
timeThe new observed removal time value of this Observation.

Definition at line 115 of file Observation.cpp.

void Observation::setSurface ( const Surface surface)

Surface value mutator.

Set the Surface value of this Observation.

Parameters:
surfaceThe new Surface value of this Observation.

Definition at line 50 of file Observation.cpp.

void Observation::setTime ( const ros::Time time)

Time value mutator.

Set the time value of this Observation.

Parameters:
timeThe new time value of this Observation.

Definition at line 85 of file Observation.cpp.


Member Data Documentation

The Item in this Observation.

Definition at line 230 of file Observation.h.

The Pose in this Observation.

Definition at line 234 of file Observation.h.

Definition at line 236 of file Observation.h.

Definition at line 236 of file Observation.h.

The Surface in this Observation.

Definition at line 232 of file Observation.h.

The various timestamps in this Observation.

Definition at line 236 of file Observation.h.


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


worldlib
Author(s): Russell Toris
autogenerated on Fri Feb 12 2016 00:24:19