Detailed Description

A set of hypothesis IDs, used for arcs and nodes in multi-hypothesis hybrid maps.

See also: THypothesisID, CHierarchicalMHMap

Definition at line 78 of file HMT_SLAM_common.h.

#include <mrpt/hmtslam/HMT_SLAM_common.h>

Inheritance diagram for mrpt::hmtslam::THypothesisIDSet:

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 ()

	THypothesisIDSet ()
	Default constructor. More...

	THypothesisIDSet (const THypothesisID &val)
	Constructor with one initial element. More...

virtual	~THypothesisIDSet ()

bool	has (const THypothesisID &val) const
	Returns true if the hypothesis is into the set. More...

void	debugDump () const
	Dump to console. More...

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

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

RTTI classes and functions
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...

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

Public Attributes
K	keys
	STL member. More...

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

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

Protected Member Functions
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 THypothesisIDSetPtr	Ptr

typedef THypothesisIDSetPtr	ConstPtr

static mrpt::utils::CLASSINIT	_init_THypothesisIDSet

static mrpt::utils::TRuntimeClassId	classTHypothesisIDSet

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 THypothesisIDSetPtr	Create ()

Member Typedef Documentation

◆ ConstPtr

typedef THypothesisIDSetPtr mrpt::hmtslam::THypothesisIDSet::ConstPtr

Definition at line 81 of file HMT_SLAM_common.h.

◆ Ptr

typedef THypothesisIDSetPtr mrpt::hmtslam::THypothesisIDSet::Ptr

A typedef for the associated smart pointer

Definition at line 81 of file HMT_SLAM_common.h.

Constructor & Destructor Documentation

◆ THypothesisIDSet() [1/2]

mrpt::hmtslam::THypothesisIDSet::THypothesisIDSet ( )

inline

Default constructor.

Definition at line 86 of file HMT_SLAM_common.h.

◆ THypothesisIDSet() [2/2]

mrpt::hmtslam::THypothesisIDSet::THypothesisIDSet ( const THypothesisID & val )

inline

Constructor with one initial element.

Definition at line 92 of file HMT_SLAM_common.h.

References val.

◆ ~THypothesisIDSet()

virtual mrpt::hmtslam::THypothesisIDSet::~THypothesisIDSet ( )

inlinevirtual

Definition at line 97 of file HMT_SLAM_common.h.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

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

inlineinherited

Cloning interface for smart pointers.

Definition at line 133 of file CObject.h.

◆ Create()

static THypothesisIDSetPtr mrpt::hmtslam::THypothesisIDSet::Create ( )

static

◆ CreateObject()

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

static

◆ debugDump()

void mrpt::hmtslam::THypothesisIDSet::debugDump ( ) const

Dump to console.

◆ duplicate()

virtual mrpt::utils::CObject* mrpt::hmtslam::THypothesisIDSet::duplicate ( ) const

virtual

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

Implements mrpt::utils::CObject.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr 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 162 of file CObject.h.

References mrpt::utils::CObjectPtr.

Referenced by mrpt::obs::CRawlog::addActions(), mrpt::slam::CIncrementalMapPartitioner::addMapFrame(), and mrpt::obs::CRawlog::addObservations().

◆ GetRuntimeClass()

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

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

◆ has()

bool mrpt::hmtslam::THypothesisIDSet::has ( const THypothesisID & val ) const

inline

Returns true if the hypothesis is into the set.

Definition at line 103 of file HMT_SLAM_common.h.

References COMMON_TOPOLOG_HYP, mrpt::utils::find(), and val.

◆ operator delete() [1/3]

void mrpt::hmtslam::THypothesisIDSet::operator delete	(	void *	ptr	)
throw	(
	)

inline

Definition at line 81 of file HMT_SLAM_common.h.

◆ operator delete() [2/3]

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

inline

Definition at line 81 of file HMT_SLAM_common.h.

◆ operator delete() [3/3]

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

inline

Definition at line 81 of file HMT_SLAM_common.h.

◆ operator delete[]()

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

inline

Definition at line 81 of file HMT_SLAM_common.h.

◆ operator new() [1/3]

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

inline

Definition at line 81 of file HMT_SLAM_common.h.

◆ operator new() [2/3]

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

inlinestatic

Definition at line 81 of file HMT_SLAM_common.h.

◆ operator new() [3/3]

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

inline

Definition at line 81 of file HMT_SLAM_common.h.

◆ operator new[]()

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

inline

Definition at line 81 of file HMT_SLAM_common.h.

◆ readFromStream()

void THypothesisIDSet::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.

Definition at line 42 of file THypothesisIDSet.cpp.

References mrpt::utils::clear(), MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and 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 NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

◆ writeToStream()

void THypothesisIDSet::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.

Definition at line 24 of file THypothesisIDSet.cpp.

References begin(), and version.

Member Data Documentation

◆ _init_THypothesisIDSet

mrpt::utils::CLASSINIT mrpt::hmtslam::THypothesisIDSet::_init_THypothesisIDSet

staticprotected

Definition at line 81 of file HMT_SLAM_common.h.

◆ classCObject

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

staticinherited

Definition at line 118 of file CObject.h.

◆ classCSerializable

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

staticinherited

Definition at line 42 of file CSerializable.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::hmtslam::THypothesisIDSet::classinfo

static

Definition at line 81 of file HMT_SLAM_common.h.

◆ classTHypothesisIDSet

mrpt::utils::TRuntimeClassId mrpt::hmtslam::THypothesisIDSet::classTHypothesisIDSet

static

Definition at line 81 of file HMT_SLAM_common.h.

◆ keys

K std::set< K >::keys

inherited

STL member.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ THypothesisIDSet() [1/2]

◆ THypothesisIDSet() [2/2]

◆ ~THypothesisIDSet()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ debugDump()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ GetRuntimeClass()

◆ has()

◆ 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_THypothesisIDSet

◆ classCObject

◆ classCSerializable

◆ classinfo

◆ classTHypothesisIDSet

◆ keys