mrpt::hmtslam::THypothesisIDSet Class Reference

Detailed Description

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

See also

THypothesisID, CHierarchicalMHMap

Definition at line 75 of file HMT_SLAM_common.h.

#include <mrpt/hmtslam/HMT_SLAM_common.h>

Inheritance diagram for mrpt::hmtslam::THypothesisIDSet:

Public Member Functions
	THypothesisIDSet ()=default
	Default constructor. More...
	THypothesisIDSet (const THypothesisID &val)
	Constructor with one initial element. More...
	~THypothesisIDSet () override=default
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...
RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr	duplicateGetSmartPtr () const
	Makes a deep copy of the object and returns a smart pointer to it. More...

Public Attributes
K	keys
	STL member. More...

Protected Member Functions
CSerializable virtual methods
uint8_t	serializeGetVersion () const override
	Must return the current versioning number of the object. More...
void	serializeTo (mrpt::serialization::CArchive &out) const override
	Pure virtual method for writing (serializing) to an abstract archive. More...
void	serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
	Pure virtual method for reading (deserializing) from an abstract archive. More...
CSerializable virtual methods
virtual void	serializeTo (CSchemeArchiveBase &out) const
	Virtual method for writing (serializing) to an abstract schema based archive. More...
virtual void	serializeFrom (CSchemeArchiveBase &in)
	Virtual method for reading (deserializing) from an abstract schema based archive. More...

RTTI stuff
using	Ptr = std::shared_ptr< mrpt::hmtslam ::THypothesisIDSet >
using	ConstPtr = std::shared_ptr< const mrpt::hmtslam ::THypothesisIDSet >
using	UniquePtr = std::unique_ptr< mrpt::hmtslam ::THypothesisIDSet >
using	ConstUniquePtr = std::unique_ptr< const mrpt::hmtslam ::THypothesisIDSet >
static const mrpt::rtti::TRuntimeClassId	runtimeClassId
static constexpr const char *	className = "mrpt::hmtslam" "::" "THypothesisIDSet"
static const mrpt::rtti::TRuntimeClassId *	_GetBaseClass ()
static constexpr auto	getClassName ()
static const mrpt::rtti::TRuntimeClassId &	GetRuntimeClassIdStatic ()
static std::shared_ptr< CObject >	CreateObject ()
template<typename... Args>
static Ptr	Create (Args &&... args)
template<typename Alloc , typename... Args>
static Ptr	CreateAlloc (const Alloc &alloc, Args &&... args)
template<typename... Args>
static UniquePtr	CreateUnique (Args &&... args)
virtual const mrpt::rtti::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...
virtual mrpt::rtti::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Member Typedef Documentation

ConstPtr

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

Definition at line 78 of file HMT_SLAM_common.h.

ConstUniquePtr

using mrpt::hmtslam::THypothesisIDSet::ConstUniquePtr = std::unique_ptr<const mrpt::hmtslam :: THypothesisIDSet >

Definition at line 78 of file HMT_SLAM_common.h.

Ptr

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

A type for the associated smart pointer

Definition at line 78 of file HMT_SLAM_common.h.

UniquePtr

using mrpt::hmtslam::THypothesisIDSet::UniquePtr = std::unique_ptr< mrpt::hmtslam :: THypothesisIDSet >

Definition at line 78 of file HMT_SLAM_common.h.

Constructor & Destructor Documentation

THypothesisIDSet() [1/2]

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

default

Default constructor.

THypothesisIDSet() [2/2]

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

inline

Constructor with one initial element.

Definition at line 86 of file HMT_SLAM_common.h.

References val.

~THypothesisIDSet()

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

overridedefault

Member Function Documentation

_GetBaseClass()

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

staticprotected

clone()

virtual mrpt::rtti::CObject* mrpt::hmtslam::THypothesisIDSet::clone ( ) const

overridevirtual

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

Implements mrpt::rtti::CObject.

Create()

template<typename... Args>

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

inlinestatic

Definition at line 78 of file HMT_SLAM_common.h.

CreateAlloc()

template<typename Alloc , typename... Args>

static Ptr mrpt::hmtslam::THypothesisIDSet::CreateAlloc ( const Alloc &  alloc, Args &&...  args  )

inlinestatic

Definition at line 78 of file HMT_SLAM_common.h.

CreateObject()

static std::shared_ptr<CObject> mrpt::hmtslam::THypothesisIDSet::CreateObject ( )

static

CreateUnique()

template<typename... Args>

static UniquePtr mrpt::hmtslam::THypothesisIDSet::CreateUnique ( Args &&...  args )

inlinestatic

Definition at line 78 of file HMT_SLAM_common.h.

debugDump()

void mrpt::hmtslam::THypothesisIDSet::debugDump

(

)

const

Dump to console.

duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Makes a deep copy of the object and returns a smart pointer to it.

Definition at line 204 of file CObject.h.

References mrpt::rtti::CObject::clone().

Referenced by mrpt::obs::CRawlog::insert().

Here is the call graph for this function:

Here is the caller graph for this function:

getClassName()

static constexpr auto mrpt::hmtslam::THypothesisIDSet::getClassName ( )

inlinestatic

Definition at line 78 of file HMT_SLAM_common.h.

GetRuntimeClass()

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

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::serialization::CSerializable.

GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::hmtslam::THypothesisIDSet::GetRuntimeClassIdStatic ( )

static

has()

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

inline

Returns true if the hypothesis is into the set.

Definition at line 90 of file HMT_SLAM_common.h.

References COMMON_TOPOLOG_HYP, mrpt::containers::end(), mrpt::containers::find(), and val.

Here is the call graph for this function:

serializeFrom() [1/2]

virtual void mrpt::serialization::CSerializable::serializeFrom ( CSchemeArchiveBase &  in )

inlineprotectedvirtualinherited

Virtual method for reading (deserializing) from an abstract schema based archive.

Definition at line 74 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

serializeFrom() [2/2]

void THypothesisIDSet::serializeFrom ( mrpt::serialization::CArchive &  in, uint8_t  serial_version  )

overrideprotectedvirtual

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

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 I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 24 of file THypothesisIDSet.cpp.

References mrpt::containers::clear(), and MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

Here is the call graph for this function:

serializeGetVersion()

uint8_t THypothesisIDSet::serializeGetVersion ( ) const

overrideprotectedvirtual

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implements mrpt::serialization::CSerializable.

Definition at line 16 of file THypothesisIDSet.cpp.

serializeTo() [1/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CSchemeArchiveBase &  out ) const

inlineprotectedvirtualinherited

Virtual method for writing (serializing) to an abstract schema based archive.

Definition at line 64 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

serializeTo() [2/2]

void THypothesisIDSet::serializeTo ( mrpt::serialization::CArchive &  out ) const

overrideprotectedvirtual

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions

std::exception

On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 17 of file THypothesisIDSet.cpp.

References out, and mrpt::math::size().

Here is the call graph for this function:

writeToMatlab()

virtual mxArray* mrpt::serialization::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 90 of file CSerializable.h.

Member Data Documentation

className

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

static

Definition at line 78 of file HMT_SLAM_common.h.

keys

K std::set< K >::keys

inherited

STL member.

runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::hmtslam::THypothesisIDSet::runtimeClassId

staticprotected

Definition at line 78 of file HMT_SLAM_common.h.