MRPT  2.0.4
Classes | Namespaces
CObject.h File Reference
#include <mrpt/core/aligned_allocator.h>
#include <mrpt/core/safe_pointers.h>
#include <mrpt/typemeta/static_string.h>
#include <functional>
#include <memory>
#include <vector>

Go to the source code of this file.

Classes

struct  mrpt::rtti::TRuntimeClassId
 A structure that holds runtime class type information. More...
 
struct  mrpt::rtti::CLASS_ID_impl< T >
 
struct  mrpt::rtti::IS_CLASS_impl< T >
 
struct  mrpt::rtti::internal::CopyCtor< is_copy_ctrtible >
 
struct  mrpt::rtti::internal::CopyCtor< true >
 
struct  mrpt::rtti::internal::CopyCtor< false >
 
class  mrpt::rtti::CObject
 Virtual base to provide a compiler-independent RTTI system. More...
 
struct  mrpt::ptr_cast< CAST_TO >
 Converts a polymorphic smart pointer Base::Ptr to Derived::Ptr, in a way compatible with MRPT >=1.5.4 and MRPT 2.x series. More...
 

Namespaces

 mrpt
 This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries.
 
 mrpt::rtti
 
 mrpt::rtti::internal
 

Functions

RTTI classes and functions for polymorphic hierarchies
void mrpt::rtti::registerClass (const mrpt::rtti::TRuntimeClassId *pNewClass)
 Register a class into the MRPT internal list of "CObject" descendents. More...
 
void mrpt::rtti::registerClassCustomName (const char *customName, const TRuntimeClassId *pNewClass)
 Mostly for internal use within mrpt sources, to handle exceptional cases with multiple serialization names for backward compatibility (CMultiMetricMaps, CImage,...) More...
 
std::vector< const mrpt::rtti::TRuntimeClassId * > mrpt::rtti::getAllRegisteredClasses ()
 Returns a list with all the classes registered in the system through mrpt::rtti::registerClass. More...
 
std::vector< const TRuntimeClassId * > mrpt::rtti::getAllRegisteredClassesChildrenOf (const TRuntimeClassId *parent_id)
 Like getAllRegisteredClasses(), but filters the list to only include children clases of a given base one. More...
 
const TRuntimeClassIdmrpt::rtti::findRegisteredClass (const std::string &className, const bool allow_ignore_namespace=true)
 Return info about a given class by its name, or nullptr if the class is not registered. More...
 
void mrpt::rtti::registerAllPendingClasses ()
 Register all pending classes - to be called just before de-serializing an object, for example. More...
 
mrpt::rtti::CObject::Ptr mrpt::rtti::classFactory (const std::string &className)
 Creates an object given by its registered name. More...
 

RTTI classes and functions for polymorphic hierarchies

#define CLASS_ID(T)   mrpt::rtti::CLASS_ID_impl<T>::get()
 Access to runtime class ID for a defined class name. More...
 
#define CLASS_ID_TEMPLATE(class_name, T)   mrpt::rtti::CLASS_ID_impl<T>::get()
 
#define CLASS_ID_NAMESPACE(class_name, namespaceName)   mrpt::rtti::CLASS_ID_impl<namespaceName::class_name>::get()
 
#define IS_CLASS(obj, class_name)   mrpt::rtti::IS_CLASS_impl<class_name>::check(obj)
 True if the given reference to object (derived from mrpt::rtti::CObject) is of the given class. More...
 
#define IS_DERIVED(obj, class_name)   ((obj).GetRuntimeClass()->derivedFrom(CLASS_ID(class_name)))
 True if the given reference to object (derived from mrpt::rtti::CObject) is an instance of the given class OR any of its derived classes. More...
 
#define DEFINE_MRPT_OBJECT(class_name, NameSpace)
 This declaration must be inserted in all CObject classes definition, within the class declaration. More...
 
#define INTERNAL_IMPLEMENTS_MRPT_OBJECT( class_name, base, NameSpace, class_registry_name)
 
#define IMPLEMENTS_MRPT_OBJECT(class_name, base, NameSpace)
 Must be added to all CObject-derived classes implementation file. More...
 
#define DEFINE_VIRTUAL_MRPT_OBJECT(class_name)
 This declaration must be inserted in virtual CObject classes definition: More...
 
#define INTERNAL_IMPLEMENTS_VIRTUAL_MRPT_OBJECT( class_name, base_name, NS, registered_name)
 This must be inserted as implementation of some required members for virtual CObject classes: More...
 
#define IMPLEMENTS_VIRTUAL_MRPT_OBJECT(class_name, base, NS)
 
void mrpt::rtti::registerClass (const mrpt::rtti::TRuntimeClassId *pNewClass)
 Register a class into the MRPT internal list of "CObject" descendents. More...
 
void mrpt::rtti::registerClassCustomName (const char *customName, const TRuntimeClassId *pNewClass)
 Mostly for internal use within mrpt sources, to handle exceptional cases with multiple serialization names for backward compatibility (CMultiMetricMaps, CImage,...) More...
 
std::vector< const mrpt::rtti::TRuntimeClassId * > mrpt::rtti::getAllRegisteredClasses ()
 Returns a list with all the classes registered in the system through mrpt::rtti::registerClass. More...
 
std::vector< const TRuntimeClassId * > mrpt::rtti::getAllRegisteredClassesChildrenOf (const TRuntimeClassId *parent_id)
 Like getAllRegisteredClasses(), but filters the list to only include children clases of a given base one. More...
 
const TRuntimeClassIdmrpt::rtti::findRegisteredClass (const std::string &className, const bool allow_ignore_namespace=true)
 Return info about a given class by its name, or nullptr if the class is not registered. More...
 
void mrpt::rtti::registerAllPendingClasses ()
 Register all pending classes - to be called just before de-serializing an object, for example. More...
 
mrpt::rtti::CObject::Ptr mrpt::rtti::classFactory (const std::string &className)
 Creates an object given by its registered name. More...
 

Macro Definition Documentation

◆ CLASS_ID

#define CLASS_ID (   T)    mrpt::rtti::CLASS_ID_impl<T>::get()

Access to runtime class ID for a defined class name.

Examples
rtti_example1/test.cpp.

Definition at line 102 of file CObject.h.

◆ CLASS_ID_NAMESPACE

#define CLASS_ID_NAMESPACE (   class_name,
  namespaceName 
)    mrpt::rtti::CLASS_ID_impl<namespaceName::class_name>::get()
Examples
rtti_example1/test.cpp.

Definition at line 105 of file CObject.h.

◆ CLASS_ID_TEMPLATE

#define CLASS_ID_TEMPLATE (   class_name,
 
)    mrpt::rtti::CLASS_ID_impl<T>::get()

Definition at line 104 of file CObject.h.

◆ DEFINE_MRPT_OBJECT

#define DEFINE_MRPT_OBJECT (   class_name,
  NameSpace 
)

This declaration must be inserted in all CObject classes definition, within the class declaration.

Examples
rtti_example1/test.cpp.

Definition at line 211 of file CObject.h.

◆ DEFINE_VIRTUAL_MRPT_OBJECT

#define DEFINE_VIRTUAL_MRPT_OBJECT (   class_name)
Value:
/*! @name RTTI stuff */ \
/*! @{ */ \
protected: \
static const mrpt::rtti::TRuntimeClassId* _GetBaseClass(); \
static const mrpt::rtti::TRuntimeClassId runtimeClassId; \
\
public: \
using Ptr = std::shared_ptr<class_name>; \
using ConstPtr = std::shared_ptr<const class_name>; \
virtual const mrpt::rtti::TRuntimeClassId* GetRuntimeClass() \
const override; \
static const mrpt::rtti::TRuntimeClassId& GetRuntimeClassIdStatic(); \
/*! @} */

This declaration must be inserted in virtual CObject classes definition:

Examples
rtti_example1/test.cpp.

Definition at line 293 of file CObject.h.

◆ IMPLEMENTS_MRPT_OBJECT

#define IMPLEMENTS_MRPT_OBJECT (   class_name,
  base,
  NameSpace 
)
Value:
class_name, base, NameSpace, #NameSpace "::" #class_name)

Must be added to all CObject-derived classes implementation file.

This registers class ns1::Foo as "ns1::Foo".

Definition at line 286 of file CObject.h.

◆ IMPLEMENTS_VIRTUAL_MRPT_OBJECT

#define IMPLEMENTS_VIRTUAL_MRPT_OBJECT (   class_name,
  base,
  NS 
)
Value:
class_name, base, NS, #NS "::" #class_name)

Definition at line 329 of file CObject.h.

◆ INTERNAL_IMPLEMENTS_MRPT_OBJECT

#define INTERNAL_IMPLEMENTS_MRPT_OBJECT (   class_name,
  base,
  NameSpace,
  class_registry_name 
)
Value:
mrpt::rtti::CObject::Ptr NameSpace::class_name::CreateObject() \
{ \
return std::static_pointer_cast<CObject>( \
std::make_shared<NameSpace::class_name>()); \
} \
const mrpt::rtti::TRuntimeClassId* NameSpace::class_name::_GetBaseClass() \
{ \
return CLASS_ID(base); \
} \
NameSpace::class_name::GetRuntimeClassIdStatic() \
{ \
return NameSpace::class_name::runtimeClassId; \
} \
const mrpt::rtti::TRuntimeClassId NameSpace::class_name::runtimeClassId = \
{class_registry_name, NameSpace::class_name::CreateObject, \
&class_name::_GetBaseClass}; \
NameSpace::class_name::GetRuntimeClass() const \
{ \
return CLASS_ID_NAMESPACE(class_name, NameSpace); \
} \
mrpt::rtti::CObject* NameSpace::class_name::clone() const \
{ \
return mrpt::rtti::internal::CopyCtor<std::is_copy_constructible< \
NameSpace::class_name>::value>::clone(*this); \
}

Definition at line 253 of file CObject.h.

◆ INTERNAL_IMPLEMENTS_VIRTUAL_MRPT_OBJECT

#define INTERNAL_IMPLEMENTS_VIRTUAL_MRPT_OBJECT (   class_name,
  base_name,
  NS,
  registered_name 
)
Value:
const mrpt::rtti::TRuntimeClassId* NS::class_name::_GetBaseClass() \
{ \
return CLASS_ID(base_name); \
} \
const mrpt::rtti::TRuntimeClassId NS::class_name::runtimeClassId = { \
registered_name, nullptr, &NS::class_name::_GetBaseClass}; \
const mrpt::rtti::TRuntimeClassId* NS::class_name::GetRuntimeClass() const \
{ \
return CLASS_ID(class_name); \
} \
NS::class_name::GetRuntimeClassIdStatic() \
{ \
return NS::class_name::runtimeClassId; \
}

This must be inserted as implementation of some required members for virtual CObject classes:

Definition at line 311 of file CObject.h.

◆ IS_CLASS

#define IS_CLASS (   obj,
  class_name 
)    mrpt::rtti::IS_CLASS_impl<class_name>::check(obj)

True if the given reference to object (derived from mrpt::rtti::CObject) is of the given class.

Examples
rtti_example1/test.cpp.

Definition at line 146 of file CObject.h.

◆ IS_DERIVED

#define IS_DERIVED (   obj,
  class_name 
)    ((obj).GetRuntimeClass()->derivedFrom(CLASS_ID(class_name)))

True if the given reference to object (derived from mrpt::rtti::CObject) is an instance of the given class OR any of its derived classes.

Examples
rtti_example1/test.cpp.

Definition at line 151 of file CObject.h.

mrpt::rtti::CObject::Ptr
std::shared_ptr< CObject > Ptr
Definition: CObject.h:184
mrpt::rtti::TRuntimeClassId
A structure that holds runtime class type information.
Definition: CObject.h:31
INTERNAL_IMPLEMENTS_VIRTUAL_MRPT_OBJECT
#define INTERNAL_IMPLEMENTS_VIRTUAL_MRPT_OBJECT( class_name, base_name, NS, registered_name)
This must be inserted as implementation of some required members for virtual CObject classes:
Definition: CObject.h:311
mrpt::rtti::internal::CopyCtor
Definition: CObject.h:121
CLASS_ID_NAMESPACE
#define CLASS_ID_NAMESPACE(class_name, namespaceName)
Definition: CObject.h:105
INTERNAL_IMPLEMENTS_MRPT_OBJECT
#define INTERNAL_IMPLEMENTS_MRPT_OBJECT( class_name, base, NameSpace, class_registry_name)
Definition: CObject.h:253
CLASS_ID
#define CLASS_ID(T)
Access to runtime class ID for a defined class name.
Definition: CObject.h:102



Page generated by Doxygen 1.8.17 for MRPT 2.0.4 at Sat Jun 27 14:00:59 UTC 2020