Observation information from an SQL entity in the spatial world database. More...

#include <SpatialWorldObservation.h>

Inheritance diagram for rail::spatial_temporal_learning::worldlib::remote::SpatialWorldObservation:

Public Member Functions
const std::string &	getItemName () const
	Item name value accessor.
const geometry::Pose &	getPose () const
	Pose value accessor (immutable).
geometry::Pose &	getPose ()
	Pose value accessor.
const ros::Time &	getRemovedEstimate () const
	Estimated removal time value accessor (immutable).
ros::Time &	getRemovedEstimate ()
	Estimated removal time value accessor.
const ros::Time &	getRemovedObserved () const
	Observed removal time value accessor (immutable).
ros::Time &	getRemovedObserved ()
	Observed removal time value accessor.
const std::string &	getSurfaceFrameID () const
	Surface frame ID value accessor.
const std::string &	getSurfaceName () const
	Surface name value accessor.
const ros::Time &	getTime () const
	Time value accessor (immutable).
ros::Time &	getTime ()
	Time value accessor.
void	setItemName (const std::string &item_name)
	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	setSurfaceFrameID (const std::string &surface_frame_id)
	Surface frame ID value mutator.
void	setSurfaceName (const std::string &surface_name)
	Surface name value mutator.
void	setTime (const ros::Time &time)
	Time value mutator.
	SpatialWorldObservation (const uint32_t id, const std::string &item_name, const std::string &surface_name, const std::string &surface_frame_id, const geometry::Pose &pose, const ros::Time &time, const ros::Time &removed_estimate, const ros::Time &removed_observed)
	Create a new SpatialWorldObservation.
Private Attributes
std::string	item_name_
geometry::Pose	pose_
ros::Time	removed_estimate_
ros::Time	removed_observed_
std::string	surface_frame_id_
std::string	surface_name_
ros::Time	time_

Detailed Description

Observation information from an SQL entity in the spatial world database.

An observation consists of seeing a given item on a given surface at a give pose. This class corresponds directly to an entity in the spatial world database.

Definition at line 41 of file SpatialWorldObservation.h.

Constructor & Destructor Documentation

SpatialWorldObservation::SpatialWorldObservation	(	const uint32_t	id,
		const std::string &	item_name,
		const std::string &	surface_name,
		const std::string &	surface_frame_id,
		const geometry::Pose &	pose,
		const ros::Time &	time,
		const ros::Time &	removed_estimate,
		const ros::Time &	removed_observed
	)

Create a new SpatialWorldObservation.

Create a new SpatialWorldObservation with the entity values.

Parameters:

id	The ID of the entity in the database.
item_name	The name of the item observed.
surface_name	The name of the surface the item was observed on.
surface_frame_id	The frame ID of the surface the item was observed on.
pose	The Pose of the item in this observation with respect to the surface frame ID.
time	The ros::Time the observation was made
removed_estimate	The estimated ros::Time the Item was removed from the surface.
removed_observed	The observed ros::Time the Item was not seen on the surface.

Definition at line 19 of file SpatialWorldObservation.cpp.

Member Function Documentation

const string & SpatialWorldObservation::getItemName ( ) const

Item name value accessor.

Get the item name value of this SpatialWorldObservation.

Returns:: The item name value of this SpatialWorldObservation.

Definition at line 28 of file SpatialWorldObservation.cpp.

const Pose & SpatialWorldObservation::getPose ( ) const

Pose value accessor (immutable).

Get the Pose value of this SpatialWorldObservation.

Returns:: The Pose value of this SpatialWorldObservation.

Definition at line 58 of file SpatialWorldObservation.cpp.

Pose & SpatialWorldObservation::getPose ( )

Pose value accessor.

Get the Pose value of this SpatialWorldObservation.

Returns:: The Pose value of this SpatialWorldObservation.

Definition at line 63 of file SpatialWorldObservation.cpp.

const ros::Time & SpatialWorldObservation::getRemovedEstimate ( ) const

Estimated removal time value accessor (immutable).

Get the estimated removal time value of this SpatialWorldObservation.

Returns:: The estimated removal time value of this SpatialWorldObservation.

Definition at line 88 of file SpatialWorldObservation.cpp.

ros::Time & SpatialWorldObservation::getRemovedEstimate ( )

Estimated removal time value accessor.

Get the estimated removal time value of this SpatialWorldObservation.

Returns:: The estimated removal time value of this SpatialWorldObservation.

Definition at line 93 of file SpatialWorldObservation.cpp.

const ros::Time & SpatialWorldObservation::getRemovedObserved ( ) const

Observed removal time value accessor (immutable).

Get the observed removal time value of this SpatialWorldObservation.

Returns:: The observed removal time value of this SpatialWorldObservation.

Definition at line 103 of file SpatialWorldObservation.cpp.

ros::Time & SpatialWorldObservation::getRemovedObserved ( )

Observed removal time value accessor.

Get the observed removal time value of this SpatialWorldObservation.

Returns:: The observed removal time value of this SpatialWorldObservation.

Definition at line 108 of file SpatialWorldObservation.cpp.

const string & SpatialWorldObservation::getSurfaceFrameID ( ) const

Surface frame ID value accessor.

Get the surface frame ID value of this SpatialWorldObservation.

Returns:: The surface frame ID value of this SpatialWorldObservation.

Definition at line 48 of file SpatialWorldObservation.cpp.

const string & SpatialWorldObservation::getSurfaceName ( ) const

Surface name value accessor.

Get the surface name value of this SpatialWorldObservation.

Returns:: The surface name value of this SpatialWorldObservation.

Definition at line 38 of file SpatialWorldObservation.cpp.

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

Time value accessor (immutable).

Get the time value of this SpatialWorldObservation.

Returns:: The time value of this SpatialWorldObservation.

Definition at line 73 of file SpatialWorldObservation.cpp.

ros::Time & SpatialWorldObservation::getTime ( )

Time value accessor.

Get the time value of this SpatialWorldObservation.

Returns:: The time value of this SpatialWorldObservation.

Definition at line 78 of file SpatialWorldObservation.cpp.

void SpatialWorldObservation::setItemName ( const std::string & item_name )

Item value mutator.

Set the item name value of this SpatialWorldObservation.

Parameters:

item_name The new item name value of this SpatialWorldObservation.

Definition at line 33 of file SpatialWorldObservation.cpp.

void SpatialWorldObservation::setPose ( const geometry::Pose & pose )

Pose value mutator.

Set the Pose value of this SpatialWorldObservation.

Parameters:

pose	The new Pose value of this SpatialWorldObservation.

Definition at line 68 of file SpatialWorldObservation.cpp.

void SpatialWorldObservation::setRemovedEstimate ( const ros::Time & removed_estimate )

Estimated removal time value mutator.

Set the estimated removal time value of this SpatialWorldObservation.

Parameters:

time	The new estimated removal time value of this SpatialWorldObservation.

Definition at line 98 of file SpatialWorldObservation.cpp.

void SpatialWorldObservation::setRemovedObserved ( const ros::Time & removed_observed )

Observed removal time value mutator.

Set the observed removal time value of this SpatialWorldObservation.

Parameters:

time	The new observed removal time value of this SpatialWorldObservation.

Definition at line 113 of file SpatialWorldObservation.cpp.

void SpatialWorldObservation::setSurfaceFrameID ( const std::string & surface_frame_id )

Surface frame ID value mutator.

Set the surface frame ID value of this SpatialWorldObservation.

Parameters:

surface_frame_id The new surface frame ID value of this SpatialWorldObservation.

Definition at line 53 of file SpatialWorldObservation.cpp.

void SpatialWorldObservation::setSurfaceName ( const std::string & surface_name )

Surface name value mutator.

Set the surface name value of this SpatialWorldObservation.

Parameters:

surface_name The new surface name value of this SpatialWorldObservation.

Definition at line 43 of file SpatialWorldObservation.cpp.

void SpatialWorldObservation::setTime ( const ros::Time & time )

Time value mutator.

Set the time value of this SpatialWorldObservation.

Parameters:

time	The new time value of this SpatialWorldObservation.

Definition at line 83 of file SpatialWorldObservation.cpp.

Member Data Documentation

std::string rail::spatial_temporal_learning::worldlib::remote::SpatialWorldObservation::item_name_ [private]

The various identification fields in the observation.

Definition at line 226 of file SpatialWorldObservation.h.

geometry::Pose rail::spatial_temporal_learning::worldlib::remote::SpatialWorldObservation::pose_ [private]

The Pose in this observation.

Definition at line 228 of file SpatialWorldObservation.h.

ros::Time rail::spatial_temporal_learning::worldlib::remote::SpatialWorldObservation::removed_estimate_ [private]

Definition at line 230 of file SpatialWorldObservation.h.

ros::Time rail::spatial_temporal_learning::worldlib::remote::SpatialWorldObservation::removed_observed_ [private]

Definition at line 230 of file SpatialWorldObservation.h.

std::string rail::spatial_temporal_learning::worldlib::remote::SpatialWorldObservation::surface_frame_id_ [private]

Definition at line 226 of file SpatialWorldObservation.h.

std::string rail::spatial_temporal_learning::worldlib::remote::SpatialWorldObservation::surface_name_ [private]

Definition at line 226 of file SpatialWorldObservation.h.

ros::Time rail::spatial_temporal_learning::worldlib::remote::SpatialWorldObservation::time_ [private]

The various timestamps in this observation.

Definition at line 230 of file SpatialWorldObservation.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation