Detailed Description

Auxiliary class used in mrpt::slam::CLocalMetricHypothesis for HMT-SLAM; this class keeps the data relative to each local metric particle ("a robot metric path hypothesis" and its associated metric map).

Definition at line 46 of file CLocalMetricHypothesis.h.

#include <mrpt/hmtslam/CLocalMetricHypothesis.h>

Inheritance diagram for mrpt::hmtslam::CLSLAMParticleData:

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) noexcept

void	operator delete[] (void *ptr) noexcept

void	operator delete (void memory, void ptr) noexcept

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

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

	CLSLAMParticleData (const mrpt::maps::TSetOfMetricMapInitializers *mapsInitializers=nullptr)

virtual mxArray *	writeToMatlab () const
	Introduces a pure virtual method responsible for writing to a `mxArray` Matlab object, typically a MATLAB `struct` whose contents are documented in each derived class. More...

RTTI classes and functions
mrpt::utils::CObject::Ptr	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...

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

Public Attributes
mrpt::maps::CMultiMetricMap	metricMaps

TMapPoseID2Pose3D	robotPoses

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

void	readFromStream (mrpt::utils::CStream &in, int version) override
	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
using	Ptr = std::shared_ptr< CLSLAMParticleData >

using	ConstPtr = std::shared_ptr< const CLSLAMParticleData >

static mrpt::utils::CLASSINIT	_init_CLSLAMParticleData

static const mrpt::utils::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CLSLAMParticleData"

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

static const mrpt::utils::TRuntimeClassId &	GetRuntimeClassIdStatic ()

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

template<typename... Args>
static Ptr	Create (Args &&... args)

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

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

Member Typedef Documentation

◆ ConstPtr

using mrpt::hmtslam::CLSLAMParticleData::ConstPtr = std::shared_ptr<const CLSLAMParticleData >

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ Ptr

using mrpt::hmtslam::CLSLAMParticleData::Ptr = std::shared_ptr< CLSLAMParticleData >

A typedef for the associated smart pointer

Definition at line 48 of file CLocalMetricHypothesis.h.

Constructor & Destructor Documentation

◆ CLSLAMParticleData()

mrpt::hmtslam::CLSLAMParticleData::CLSLAMParticleData ( const mrpt::maps::TSetOfMetricMapInitializers * mapsInitializers = nullptr )

inline

Definition at line 51 of file CLocalMetricHypothesis.h.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

virtual mrpt::utils::CObject* mrpt::hmtslam::CLSLAMParticleData::clone ( ) const

overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::utils::CObject.

◆ Create()

template<typename... Args>

static Ptr mrpt::hmtslam::CLSLAMParticleData::Create ( Args &&... args )

inlinestatic

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ CreateObject()

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

static

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::hmtslam::CLSLAMParticleData::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

◆ GetRuntimeClassIdStatic()

static const mrpt::utils::TRuntimeClassId& mrpt::hmtslam::CLSLAMParticleData::GetRuntimeClassIdStatic ( )

static

◆ operator delete() [1/3]

void mrpt::hmtslam::CLSLAMParticleData::operator delete ( void * ptr )

inlinenoexcept

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ operator delete() [2/3]

void mrpt::hmtslam::CLSLAMParticleData::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ operator delete() [3/3]

void mrpt::hmtslam::CLSLAMParticleData::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ operator delete[]()

void mrpt::hmtslam::CLSLAMParticleData::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ operator new() [1/3]

void* mrpt::hmtslam::CLSLAMParticleData::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ operator new() [2/3]

static void* mrpt::hmtslam::CLSLAMParticleData::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ operator new() [3/3]

void* mrpt::hmtslam::CLSLAMParticleData::operator new ( size_t size )

inline

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ operator new[]()

void* mrpt::hmtslam::CLSLAMParticleData::operator new[] ( size_t size )

inline

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ readFromStream()

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

overrideprotectedvirtual

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.

Definition at line 979 of file CLocalMetricHypothesis.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const

inlinevirtualinherited

Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class.

Returns: A new mxArray (caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB.

Definition at line 89 of file CSerializable.h.

◆ writeToStream()

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

overrideprotectedvirtual

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 nullptr, 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.

Definition at line 998 of file CLocalMetricHypothesis.cpp.

Member Data Documentation

◆ _init_CLSLAMParticleData

mrpt::utils::CLASSINIT mrpt::hmtslam::CLSLAMParticleData::_init_CLSLAMParticleData

staticprotected

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ className

constexpr const char* mrpt::hmtslam::CLSLAMParticleData::className = "CLSLAMParticleData"

static

Definition at line 48 of file CLocalMetricHypothesis.h.

◆ metricMaps

mrpt::maps::CMultiMetricMap mrpt::hmtslam::CLSLAMParticleData::metricMaps

Definition at line 58 of file CLocalMetricHypothesis.h.

◆ robotPoses

TMapPoseID2Pose3D mrpt::hmtslam::CLSLAMParticleData::robotPoses

Definition at line 59 of file CLocalMetricHypothesis.h.

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::hmtslam::CLSLAMParticleData::runtimeClassId

staticprotected

Definition at line 48 of file CLocalMetricHypothesis.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CLSLAMParticleData()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ readFromStream()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CLSLAMParticleData

◆ className

◆ metricMaps

◆ robotPoses

◆ runtimeClassId