A class for representing an arc between two nodes in a hierarchical, multi-hypothesis map.
The arc itself will be considered only if some given hypothesisID matchs its own ID.
Definition at line 31 of file CHMHMapArc.h.
#include <mrpt/hmtslam/CHMHMapArc.h>
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 |
CHMHMapArc (const CHMHMapNode::TNodeID &from=0, const CHMHMapNode::TNodeID &to=0, const THypothesisIDSet &hyps=THypothesisIDSet(), CHierarchicalMHMap *parent=nullptr) | |
Private constructor (see ::Create class factory) More... | |
CHMHMapArc (CHMHMapNode::Ptr &from, CHMHMapNode::Ptr &to, const THypothesisIDSet &hyps, CHierarchicalMHMap *parent) | |
Alternative constructor, using pointers for convenience. More... | |
virtual | ~CHMHMapArc () |
Destructor. More... | |
CHMHMapNode::TNodeID | getNodeFrom () const |
Return the starting node of the arc: More... | |
CHMHMapNode::TNodeID | getNodeTo () const |
Return the ending node of the arc: 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... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
Public Attributes | |
THypothesisIDSet | m_hypotheses |
The hypothesis IDs under which this arc exists. More... | |
std::string | m_arcType |
The type of the arc, the possibilities are: More... | |
CMHPropertiesValuesList | m_annotations |
The annotations of the arc, see the general description of the class for possible properties and values. More... | |
Protected Member Functions | |
void | onNodeDestruction (CHMHMapNode *node) |
Event handler to be called just before a node is being destroyed: it should be called only for nodes involved in the arc, altought other cases must be handled without effects When a node involved in the arc is delected, the corresponding pointer in the arc will be set to nullptr and the arc is no longer a valid one. More... | |
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... | |
Protected Attributes | |
CHMHMapNode::TNodeID | m_nodeFrom |
The origin/target nodes for this arc. More... | |
CHMHMapNode::TNodeID | m_nodeTo |
mrpt::safe_ptr< CHierarchicalMHMap > | m_parent |
The hierarchical graph in which this object is into. More... | |
Friends | |
class | CHierarchicalMHMap |
class | CHMHMapNode |
class | CHierarchicalMapMHPartition |
class | TArcList |
RTTI stuff | |
using | Ptr = std::shared_ptr< CHMHMapArc > |
using | ConstPtr = std::shared_ptr< const CHMHMapArc > |
using | UniquePtr = std::unique_ptr< CHMHMapArc > |
using | ConstUniquePtr = std::unique_ptr< const CHMHMapArc > |
static mrpt::rtti::CLASSINIT | _init_CHMHMapArc |
static const mrpt::rtti::TRuntimeClassId | runtimeClassId |
static constexpr const char * | className = "CHMHMapArc" |
static const mrpt::rtti::TRuntimeClassId * | _GetBaseClass () |
static constexpr auto | getClassName () |
static const mrpt::rtti::TRuntimeClassId & | GetRuntimeClassIdStatic () |
static mrpt::rtti::CObject * | CreateObject () |
template<typename... Args> | |
static Ptr | Create (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... | |
using mrpt::hmtslam::CHMHMapArc::ConstPtr = std::shared_ptr<const CHMHMapArc > |
Definition at line 38 of file CHMHMapArc.h.
using mrpt::hmtslam::CHMHMapArc::ConstUniquePtr = std::unique_ptr<const CHMHMapArc > |
Definition at line 38 of file CHMHMapArc.h.
using mrpt::hmtslam::CHMHMapArc::Ptr = std::shared_ptr< CHMHMapArc > |
A type for the associated smart pointer
Definition at line 38 of file CHMHMapArc.h.
using mrpt::hmtslam::CHMHMapArc::UniquePtr = std::unique_ptr< CHMHMapArc > |
Definition at line 38 of file CHMHMapArc.h.
CHMHMapArc::CHMHMapArc | ( | const CHMHMapNode::TNodeID & | from = 0 , |
const CHMHMapNode::TNodeID & | to = 0 , |
||
const THypothesisIDSet & | hyps = THypothesisIDSet() , |
||
CHierarchicalMHMap * | parent = nullptr |
||
) |
Private constructor (see ::Create class factory)
Definition at line 21 of file CHMHMapArc.cpp.
CHMHMapArc::CHMHMapArc | ( | CHMHMapNode::Ptr & | from, |
CHMHMapNode::Ptr & | to, | ||
const THypothesisIDSet & | hyps, | ||
CHierarchicalMHMap * | parent | ||
) |
Alternative constructor, using pointers for convenience.
Definition at line 39 of file CHMHMapArc.cpp.
References m_nodeFrom, and m_nodeTo.
|
virtual |
Destructor.
Definition at line 59 of file CHMHMapArc.cpp.
References m_nodeFrom, m_nodeTo, and m_parent.
|
staticprotected |
|
overridevirtual |
Returns a deep copy (clone) of the object, indepently of its class.
Implements mrpt::rtti::CObject.
|
inlinestatic |
Definition at line 38 of file CHMHMapArc.h.
|
static |
|
inlinestatic |
Definition at line 38 of file CHMHMapArc.h.
|
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 169 of file CObject.h.
References mrpt::rtti::CObject::clone().
Referenced by mrpt::obs::CRawlog::addActions(), and mrpt::obs::CRawlog::addObservations().
|
inlinestaticconstexpr |
Definition at line 38 of file CHMHMapArc.h.
|
inline |
Return the starting node of the arc:
Definition at line 82 of file CHMHMapArc.h.
References AREAID_INVALID, ASSERT_, and m_nodeFrom.
|
inline |
Return the ending node of the arc:
Definition at line 90 of file CHMHMapArc.h.
References AREAID_INVALID, ASSERT_, and m_nodeTo.
|
overridevirtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::serialization::CSerializable.
|
static |
|
protected |
Event handler to be called just before a node is being destroyed: it should be called only for nodes involved in the arc, altought other cases must be handled without effects When a node involved in the arc is delected, the corresponding pointer in the arc will be set to nullptr and the arc is no longer a valid one.
Definition at line 74 of file CHMHMapArc.cpp.
References AREAID_INVALID, mrpt::hmtslam::CHMHMapNode::getID(), m_nodeFrom, m_nodeTo, MRPT_END, and MRPT_START.
Definition at line 38 of file CHMHMapArc.h.
Definition at line 38 of file CHMHMapArc.h.
|
inlinenoexcept |
Definition at line 38 of file CHMHMapArc.h.
Definition at line 38 of file CHMHMapArc.h.
|
inline |
Definition at line 38 of file CHMHMapArc.h.
|
inlinenoexcept |
Definition at line 38 of file CHMHMapArc.h.
Definition at line 38 of file CHMHMapArc.h.
|
inline |
Definition at line 38 of file CHMHMapArc.h.
|
overrideprotectedvirtual |
Pure virtual method for reading (deserializing) from an abstract archive.
Users don't call this method directly. Instead, use stream >> object;
.
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. |
std::exception | On any I/O error |
Implements mrpt::serialization::CSerializable.
Definition at line 91 of file CHMHMapArc.cpp.
References ASSERTMSG_, m_annotations, m_arcType, m_hypotheses, m_nodeFrom, m_nodeTo, m_parent, and MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.
|
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 85 of file CHMHMapArc.cpp.
|
overrideprotectedvirtual |
Pure virtual method for writing (serializing) to an abstract archive.
Users don't call this method directly. Instead, use stream << object;
.
std::exception | On any I/O error |
Implements mrpt::serialization::CSerializable.
Definition at line 86 of file CHMHMapArc.cpp.
References m_annotations, m_arcType, m_hypotheses, m_nodeFrom, and m_nodeTo.
|
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.
mxArray
(caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB. Definition at line 70 of file CSerializable.h.
|
friend |
Definition at line 35 of file CHMHMapArc.h.
|
friend |
Definition at line 33 of file CHMHMapArc.h.
|
friend |
Definition at line 34 of file CHMHMapArc.h.
|
friend |
Definition at line 36 of file CHMHMapArc.h.
|
staticprotected |
Definition at line 38 of file CHMHMapArc.h.
|
staticconstexpr |
Definition at line 38 of file CHMHMapArc.h.
CMHPropertiesValuesList mrpt::hmtslam::CHMHMapArc::m_annotations |
The annotations of the arc, see the general description of the class for possible properties and values.
Definition at line 106 of file CHMHMapArc.h.
Referenced by serializeFrom(), and serializeTo().
std::string mrpt::hmtslam::CHMHMapArc::m_arcType |
The type of the arc, the possibilities are:
Definition at line 101 of file CHMHMapArc.h.
Referenced by serializeFrom(), and serializeTo().
THypothesisIDSet mrpt::hmtslam::CHMHMapArc::m_hypotheses |
The hypothesis IDs under which this arc exists.
Definition at line 43 of file CHMHMapArc.h.
Referenced by serializeFrom(), and serializeTo().
|
protected |
The origin/target nodes for this arc.
Definition at line 48 of file CHMHMapArc.h.
Referenced by CHMHMapArc(), getNodeFrom(), mrpt::hmtslam::CHMHMapNode::onArcDestruction(), onNodeDestruction(), serializeFrom(), serializeTo(), and ~CHMHMapArc().
|
protected |
Definition at line 48 of file CHMHMapArc.h.
Referenced by CHMHMapArc(), getNodeTo(), mrpt::hmtslam::CHMHMapNode::onArcDestruction(), onNodeDestruction(), serializeFrom(), serializeTo(), and ~CHMHMapArc().
|
protected |
The hierarchical graph in which this object is into.
Definition at line 51 of file CHMHMapArc.h.
Referenced by serializeFrom(), and ~CHMHMapArc().
|
staticprotected |
Definition at line 38 of file CHMHMapArc.h.
Page generated by Doxygen 1.8.17 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at miƩ 12 jul 2023 10:03:34 CEST |