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 29 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) 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 () |
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... | |
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... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
static CHMHMapArcPtr | Create (const CHMHMapNode::TNodeID &from, const CHMHMapNode::TNodeID &to, const THypothesisIDSet &hyps=THypothesisIDSet(), CHierarchicalMHMap *parent=NULL) |
Constructor from node IDs. More... | |
static CHMHMapArcPtr | Create (CHMHMapNodePtr &from, CHMHMapNodePtr &to, const THypothesisIDSet &hyps, CHierarchicalMHMap *parent) |
Alternative constructor, using pointers for convenience. More... | |
Public Attributes | |
THypothesisIDSet | m_hypotheses |
The hypothesis IDs under which this arc exists. More... | |
utils::CTypeSelector | m_arcType |
The type of the arc, the possibilities are: More... | |
utils::CMHPropertiesValuesList | m_annotations |
The annotations of the arc, see the general description of the class for possible properties and values. More... | |
Static Public Attributes | |
static const mrpt::utils::TRuntimeClassId | classCObject |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCSerializable |
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 NULL and the arc is no longer a valid one. 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... | |
Protected Attributes | |
CHMHMapNode::TNodeID | m_nodeFrom |
The origin/target nodes for this arc. More... | |
CHMHMapNode::TNodeID | m_nodeTo |
mrpt::utils::safe_ptr< CHierarchicalMHMap > | m_parent |
The hierarchical graph in which this object is into. More... | |
Private Member Functions | |
CHMHMapArc (const CHMHMapNode::TNodeID &from=0, const CHMHMapNode::TNodeID &to=0, const THypothesisIDSet &hyps=THypothesisIDSet(), CHierarchicalMHMap *parent=NULL) | |
Private constructor (see ::Create class factory) More... | |
CHMHMapArc (CHMHMapNodePtr &from, CHMHMapNodePtr &to, const THypothesisIDSet &hyps, CHierarchicalMHMap *parent) | |
Alternative constructor, using pointers for convenience. More... | |
Friends | |
class | CHierarchicalMHMap |
class | CHMHMapNode |
class | CHierarchicalMapMHPartition |
class | TArcList |
RTTI stuff | |
typedef CHMHMapArcPtr | SmartPtr |
static mrpt::utils::CLASSINIT | _init_CHMHMapArc |
static mrpt::utils::TRuntimeClassId | classCHMHMapArc |
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 CHMHMapArcPtr | Create () |
typedef CHMHMapArcPtr mrpt::hmtslam::CHMHMapArc::SmartPtr |
A typedef for the associated smart pointer
Definition at line 37 of file CHMHMapArc.h.
|
private |
Private constructor (see ::Create class factory)
|
private |
Alternative constructor, using pointers for convenience.
|
virtual |
Destructor.
|
staticprotected |
|
inlineinherited |
|
static |
|
static |
Constructor from node IDs.
|
static |
Alternative constructor, using pointers for convenience.
|
static |
|
virtual |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlineinherited |
|
inline |
Return the starting node of the arc:
Definition at line 98 of file CHMHMapArc.h.
References AREAID_INVALID, and ASSERT_.
|
inline |
Return the ending node of the arc:
Definition at line 102 of file CHMHMapArc.h.
References AREAID_INVALID, and ASSERT_.
|
virtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::utils::CSerializable.
|
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 NULL and the arc is no longer a valid one.
|
inline |
Definition at line 37 of file CHMHMapArc.h.
|
inline |
Definition at line 37 of file CHMHMapArc.h.
|
inline |
Definition at line 37 of file CHMHMapArc.h.
|
inline |
Definition at line 37 of file CHMHMapArc.h.
|
inline |
Definition at line 37 of file CHMHMapArc.h.
|
inlinestatic |
Definition at line 37 of file CHMHMapArc.h.
|
inline |
Definition at line 37 of file CHMHMapArc.h.
|
inline |
Definition at line 37 of file CHMHMapArc.h.
|
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.
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 error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
|
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 NULL is class does not support conversion to MATLAB. Definition at line 79 of file CSerializable.h.
References BASE_IMPEXP, DEFINE_MRPT_OBJECT_POST, mrpt::utils::ObjectToOctetVector(), mrpt::utils::ObjectToRawString(), mrpt::utils::ObjectToString(), mrpt::utils::OctetVectorToObject(), mrpt::utils::RawStringToObject(), and mrpt::utils::StringToObject().
|
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.
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. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
|
friend |
Definition at line 33 of file CHMHMapArc.h.
|
friend |
Definition at line 31 of file CHMHMapArc.h.
|
friend |
Definition at line 32 of file CHMHMapArc.h.
|
friend |
Definition at line 34 of file CHMHMapArc.h.
|
staticprotected |
Definition at line 37 of file CHMHMapArc.h.
|
static |
Definition at line 37 of file CHMHMapArc.h.
|
staticinherited |
|
staticinherited |
Definition at line 42 of file CSerializable.h.
|
static |
Definition at line 37 of file CHMHMapArc.h.
utils::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 113 of file CHMHMapArc.h.
utils::CTypeSelector mrpt::hmtslam::CHMHMapArc::m_arcType |
The type of the arc, the possibilities are:
Definition at line 109 of file CHMHMapArc.h.
THypothesisIDSet mrpt::hmtslam::CHMHMapArc::m_hypotheses |
The hypothesis IDs under which this arc exists.
Definition at line 42 of file CHMHMapArc.h.
|
protected |
The origin/target nodes for this arc.
Definition at line 47 of file CHMHMapArc.h.
|
protected |
Definition at line 47 of file CHMHMapArc.h.
|
protected |
The hierarchical graph in which this object is into.
Definition at line 50 of file CHMHMapArc.h.
Page generated by Doxygen 1.8.11 for MRPT 1.4.0 SVN:Unversioned directory at Sun Jul 10 11:38:36 UTC 2016 |