mrpt::graphs::detail::TNodeAnnotations Struct Reference

Detailed Description

Abstract class from which NodeAnnotations related classes can be implemented.

Definition at line 18 of file TNodeAnnotations.h.

#include <mrpt/graphs/TNodeAnnotations.h>

Inheritance diagram for mrpt::graphs::detail::TNodeAnnotations:

Public Types
typedef TNodeAnnotations	self_t

Public Member Functions
	TNodeAnnotations ()
	Constructor. More...
virtual	~TNodeAnnotations ()
	Destructor. More...
	TNodeAnnotations (const TNodeAnnotations &other)
	Generic copy constructor. More...
virtual void	getAnnotsAsString (std::string *s) const
std::string	retAnnotsAsString () const
virtual bool	operator== (const TNodeAnnotations &other) const
virtual bool	operator!= (const TNodeAnnotations &other) const
TNodeAnnotations *	getCopyOfAnnots () const
	Create and return a copy of the TNodeAnnotations object at hand. More...
bool	setAnnots (const self_t &other)
	Set the properties of the current TNodeAnnotations object. More...

Public Attributes
bool	is_node_annots_empty
	Indicates if this is a dummy TNodeAnnotations struct or if it does contain meaningful data. More...

Member Typedef Documentation

self_t

typedef TNodeAnnotations mrpt::graphs::detail::TNodeAnnotations::self_t

Definition at line 19 of file TNodeAnnotations.h.

Constructor & Destructor Documentation

TNodeAnnotations() [1/2]

mrpt::graphs::detail::TNodeAnnotations::TNodeAnnotations ( )

inline

Constructor.

Definition at line 22 of file TNodeAnnotations.h.

Referenced by getCopyOfAnnots().

~TNodeAnnotations()

virtual mrpt::graphs::detail::TNodeAnnotations::~TNodeAnnotations ( )

inlinevirtual

Destructor.

Definition at line 26 of file TNodeAnnotations.h.

TNodeAnnotations() [2/2]

mrpt::graphs::detail::TNodeAnnotations::TNodeAnnotations ( const TNodeAnnotations &  other )

inline

Generic copy constructor.

Definition at line 28 of file TNodeAnnotations.h.

Member Function Documentation

getAnnotsAsString()

virtual void mrpt::graphs::detail::TNodeAnnotations::getAnnotsAsString ( std::string *  s ) const

inlinevirtual

Reimplemented in mrpt::graphs::detail::TMRSlamNodeAnnotations.

Definition at line 30 of file TNodeAnnotations.h.

References ASSERT_.

Referenced by mrpt::graphs::detail::TMRSlamNodeAnnotations::getAnnotsAsString(), and retAnnotsAsString().

getCopyOfAnnots()

TNodeAnnotations* mrpt::graphs::detail::TNodeAnnotations::getCopyOfAnnots ( ) const

inline

Create and return a copy of the TNodeAnnotations object at hand.

Warning

Caller is responsible of afterwards deleting the object which is allocaed in heap

Definition at line 51 of file TNodeAnnotations.h.

References TNodeAnnotations().

operator!=()

virtual bool mrpt::graphs::detail::TNodeAnnotations::operator!= ( const TNodeAnnotations &  other ) const

inlinevirtual

Definition at line 42 of file TNodeAnnotations.h.

operator==()

virtual bool mrpt::graphs::detail::TNodeAnnotations::operator== ( const TNodeAnnotations &  other ) const

inlinevirtual

Reimplemented in mrpt::graphs::detail::TMRSlamNodeAnnotations.

Definition at line 39 of file TNodeAnnotations.h.

retAnnotsAsString()

std::string mrpt::graphs::detail::TNodeAnnotations::retAnnotsAsString ( ) const

inline

Definition at line 33 of file TNodeAnnotations.h.

References getAnnotsAsString().

setAnnots()

bool mrpt::graphs::detail::TNodeAnnotations::setAnnots ( const self_t &  other )

inline

Set the properties of the current TNodeAnnotations object.

Returns

True if setting the annotations part is successful.

Definition at line 56 of file TNodeAnnotations.h.

Referenced by mrpt::graphs::detail::TMRSlamNodeAnnotations::setAnnots().

Member Data Documentation

is_node_annots_empty

bool mrpt::graphs::detail::TNodeAnnotations::is_node_annots_empty

Indicates if this is a dummy TNodeAnnotations struct or if it does contain meaningful data.

Definition at line 61 of file TNodeAnnotations.h.

Referenced by mrpt::graphs::detail::TNodeAnnotationsEmpty::TNodeAnnotationsEmpty().