Detailed Description

This "observation" is actually a placeholder for a text block with comments or additional parameters attached to a given rawlog file.

There should be only one of this observations in a rawlog file, and it's recommended to insert/modify them from the application RawlogViewer.

See also: CObservation

Definition at line 28 of file CObservationComment.h.

#include <mrpt/slam/CObservationComment.h>

Inheritance diagram for mrpt::slam::CObservationComment:

[legend]

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) throw ()

void	operator delete[] (void *ptr) throw ()

void	operator delete (void memory, void ptr) throw ()

void *	operator new (size_t size, const std::nothrow_t &) throw ()

void	operator delete (void *ptr, const std::nothrow_t &) throw ()

	CObservationComment ()
	Constructor. More...

virtual	~CObservationComment ()
	Destructor. More...

void	getSensorPose (CPose3D &) const
	A general method to retrieve the sensor pose on the robot. More...

void	setSensorPose (const CPose3D &)
	A general method to change the sensor pose on the robot. More...

template<class METRICMAP >
bool	insertObservationInto (METRICMAP theMap, const CPose3D robotPose=NULL) const
	This method is equivalent to: More...

void	getSensorPose (mrpt::math::TPose3D &out_sensorPose) const
	A general method to retrieve the sensor pose on the robot. More...

void	setSensorPose (const mrpt::math::TPose3D &newSensorPose)
	A general method to change the sensor pose on the robot. More...

mrpt::utils::CObjectPtr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...

CObject *	clone () const
	Cloning interface for smart pointers. More...

Delayed-load manual control methods.
virtual void	load () const
	Makes sure all images and other fields which may be externally stored are loaded in memory. More...

virtual void	unload ()
	Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect). More...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

Public Attributes
std::string	text
	The text block. More...

Data common to any observation
mrpt::system::TTimeStamp	timestamp
	The associated time-stamp. More...

std::string	sensorLabel
	An arbitrary label that can be used to identify the sensor. More...

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCObservation

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
void	swap (CObservation &o)
	Swap with another observation, ONLY the data defined here in the base class CObservation. It's protected since it'll be only called from child classes that should know what else to swap appart from these common data. More...

CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const
	Introduces a pure virtual method responsible for writing to a CStream. More...

void	readFromStream (mrpt::utils::CStream &in, int version)
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...

RTTI stuff
typedef CObservationCommentPtr	SmartPtr

static mrpt::utils::CLASSINIT	_init_CObservationComment

static mrpt::utils::TRuntimeClassId	classCObservationComment

static const mrpt::utils::TRuntimeClassId *	classinfo

static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime. More...

virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class. More...

static mrpt::utils::CObject *	CreateObject ()

static CObservationCommentPtr	Create ()

Member Typedef Documentation

typedef CObservationCommentPtr mrpt::slam::CObservationComment::SmartPtr

A typedef for the associated smart pointer

Definition at line 31 of file CObservationComment.h.

Constructor & Destructor Documentation

mrpt::slam::CObservationComment::CObservationComment ( )

inline

Constructor.

Definition at line 36 of file CObservationComment.h.

virtual mrpt::slam::CObservationComment::~CObservationComment ( )

inlinevirtual

Destructor.

Definition at line 42 of file CObservationComment.h.

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::slam::CObservationComment::_GetBaseClass ( )

staticprotected

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 139 of file CObject.h.

static CObservationCommentPtr mrpt::slam::CObservationComment::Create ( )

static

static mrpt::utils::CObject* mrpt::slam::CObservationComment::CreateObject ( )

static

virtual mrpt::utils::CObject* mrpt::slam::CObservationComment::duplicate ( ) const

virtual

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 136 of file CObject.h.

virtual const mrpt::utils::TRuntimeClassId* mrpt::slam::CObservationComment::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::slam::CObservation.

void mrpt::slam::CObservationComment::getSensorPose ( CPose3D & ) const

inlinevirtual

A general method to retrieve the sensor pose on the robot.

Note that most sensors will return a full (6D) CPose3D, but see the derived classes for more details or special cases.

See also: setSensorPose

Implements mrpt::slam::CObservation.

Definition at line 52 of file CObservationComment.h.

void mrpt::slam::CObservation::getSensorPose ( mrpt::math::TPose3D & out_sensorPose ) const

inherited

A general method to retrieve the sensor pose on the robot.

Note that most sensors will return a full (6D) CPose3D, but see the derived classes for more details or special cases.

See also: setSensorPose

template<class METRICMAP >

bool mrpt::slam::CObservation::insertObservationInto	(	METRICMAP *	theMap,
		const CPose3D *	robotPose = `NULL`
	)		const

inlineinherited

This method is equivalent to:

map->insertObservation(this, robotPose)

Parameters

theMap	The map where this observation is to be inserted: the map will be updated.
robotPose	The pose of the robot base for this observation, relative to the target metric map. Set to NULL (default) to use (0,0,0deg)

Returns: Returns true if the map has been updated, or false if this observations has nothing to do with a metric map (for example, a sound observation).

See also: CMetricMap, CMetricMap::insertObservation

Definition at line 93 of file CObservation.h.

virtual void mrpt::slam::CObservation::load ( ) const

inlinevirtualinherited

Makes sure all images and other fields which may be externally stored are loaded in memory.

Note that for all CImages, calling load() is not required since the images will be automatically loaded upon first access, so load() shouldn't be needed to be called in normal cases by the user. If all the data were alredy loaded or this object has no externally stored data fields, calling this method has no effects.

See also: unload

Reimplemented in mrpt::slam::CObservation3DRangeScan.

Definition at line 130 of file CObservation.h.

void mrpt::slam::CObservationComment::operator delete	(	void *	memory,
		void *	ptr
	)
throw	(
	)

inline

Definition at line 31 of file CObservationComment.h.

void mrpt::slam::CObservationComment::operator delete	(	void *	ptr	)
throw	(
	)

inline

Definition at line 31 of file CObservationComment.h.

void mrpt::slam::CObservationComment::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 31 of file CObservationComment.h.

void mrpt::slam::CObservationComment::operator delete[]	(	void *	ptr	)
throw	(
	)

inline

Definition at line 31 of file CObservationComment.h.

void* mrpt::slam::CObservationComment::operator new	(	size_t	size,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 31 of file CObservationComment.h.

static void* mrpt::slam::CObservationComment::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 31 of file CObservationComment.h.

void* mrpt::slam::CObservationComment::operator new ( size_t size )

inline

Definition at line 31 of file CObservationComment.h.

void* mrpt::slam::CObservationComment::operator new[] ( size_t size )

inline

Definition at line 31 of file CObservationComment.h.

void mrpt::slam::CObservationComment::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

protectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

void mrpt::slam::CObservationComment::setSensorPose ( const CPose3D & )

inlinevirtual

A general method to change the sensor pose on the robot.

Note that most sensors will use the full (6D) CPose3D, but see the derived classes for more details or special cases.

See also: getSensorPose

Implements mrpt::slam::CObservation.

Definition at line 59 of file CObservationComment.h.

void mrpt::slam::CObservation::setSensorPose ( const mrpt::math::TPose3D & newSensorPose )

inherited

A general method to change the sensor pose on the robot.

Note that most sensors will use the full (6D) CPose3D, but see the derived classes for more details or special cases.

See also: getSensorPose

void mrpt::slam::CObservation::swap ( CObservation & o )

protectedinherited

Swap with another observation, ONLY the data defined here in the base class CObservation. It's protected since it'll be only called from child classes that should know what else to swap appart from these common data.

virtual void mrpt::slam::CObservation::unload ( )

inlinevirtualinherited

Unload all images, for the case they being delayed-load images stored in external files (othewise, has no effect).

See also: load

Reimplemented in mrpt::slam::CObservation3DRangeScan.

Definition at line 134 of file CObservation.h.

void mrpt::slam::CObservationComment::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

protectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::slam::CObservationComment::_init_CObservationComment

staticprotected

Definition at line 31 of file CObservationComment.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 124 of file CObject.h.

const mrpt::utils::TRuntimeClassId mrpt::slam::CObservation::classCObservation

staticinherited

Definition at line 55 of file CObservation.h.

mrpt::utils::TRuntimeClassId mrpt::slam::CObservationComment::classCObservationComment

static

Definition at line 31 of file CObservationComment.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 38 of file CSerializable.h.

const mrpt::utils::TRuntimeClassId* mrpt::slam::CObservationComment::classinfo

static

Definition at line 31 of file CObservationComment.h.

std::string mrpt::slam::CObservation::sensorLabel

inherited

An arbitrary label that can be used to identify the sensor.

Definition at line 71 of file CObservation.h.

std::string mrpt::slam::CObservationComment::text

The text block.

Definition at line 46 of file CObservationComment.h.

mrpt::system::TTimeStamp mrpt::slam::CObservation::timestamp

inherited

The associated time-stamp.

Definition at line 67 of file CObservation.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation