Detailed Description

Examples:: rtti_example1/test.cpp.

Definition at line 19 of file serialization/src/CSerializable_unittest.cpp.

Inheritance diagram for MyNS::Foo:

Public Member Functions
	Foo ()

void	printName ()

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...

mrpt::rtti::CObject::Ptr	duplicateGetSmartPtr () const
	Makes a deep copy of the object and returns a smart pointer to it. More...

Public Attributes
int16_t	value

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< Foo >

using	ConstPtr = std::shared_ptr< const Foo >

using	UniquePtr = std::unique_ptr< Foo >

using	ConstUniquePtr = std::unique_ptr< const Foo >

using	Ptr = std::shared_ptr< Foo >

using	ConstPtr = std::shared_ptr< const Foo >

using	UniquePtr = std::unique_ptr< Foo >

using	ConstUniquePtr = std::unique_ptr< const Foo >

static mrpt::rtti::CLASSINIT	_init_Foo

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "Foo"

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

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)

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...

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 [1/2]

using MyNS::Foo::ConstPtr = std::shared_ptr<const Foo >

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ ConstPtr [2/2]

using MyNS::Foo::ConstPtr = std::shared_ptr<const Foo >

Definition at line 22 of file vision_stereo_rectify/test.cpp.

◆ ConstUniquePtr [1/2]

using MyNS::Foo::ConstUniquePtr = std::unique_ptr<const Foo >

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ ConstUniquePtr [2/2]

using MyNS::Foo::ConstUniquePtr = std::unique_ptr<const Foo >

Definition at line 22 of file vision_stereo_rectify/test.cpp.

◆ Ptr [1/2]

using MyNS::Foo::Ptr = std::shared_ptr< Foo >

A type for the associated smart pointer

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ Ptr [2/2]

using MyNS::Foo::Ptr = std::shared_ptr< Foo >

A type for the associated smart pointer

Definition at line 22 of file vision_stereo_rectify/test.cpp.

◆ UniquePtr [1/2]

using MyNS::Foo::UniquePtr = std::unique_ptr< Foo >

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ UniquePtr [2/2]

using MyNS::Foo::UniquePtr = std::unique_ptr< Foo >

Definition at line 22 of file vision_stereo_rectify/test.cpp.

Constructor & Destructor Documentation

◆ Foo()

MyNS::Foo::Foo ( )

inline

Examples:: rtti_example1/test.cpp.

Definition at line 21 of file vision_stereo_rectify/test.cpp.

Member Function Documentation

◆ _GetBaseClass() [1/2]

static const mrpt::rtti::TRuntimeClassId* MyNS::Foo::_GetBaseClass ( )

staticprotected

◆ _GetBaseClass() [2/2]

static const mrpt::rtti::TRuntimeClassId* MyNS::Foo::_GetBaseClass ( )

staticprotected

◆ clone() [1/2]

virtual mrpt::rtti::CObject* MyNS::Foo::clone ( ) const

overridevirtual

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

Implements mrpt::rtti::CObject.

◆ clone() [2/2]

virtual mrpt::rtti::CObject* MyNS::Foo::clone ( ) const

overridevirtual

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

Implements mrpt::rtti::CObject.

◆ Create() [1/2]

template<typename... Args>

static Ptr MyNS::Foo::Create ( Args &&... args )

inlinestatic

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ Create() [2/2]

template<typename... Args>

static Ptr MyNS::Foo::Create ( Args &&... args )

inlinestatic

Definition at line 22 of file vision_stereo_rectify/test.cpp.

◆ CreateAlloc() [1/2]

template<typename Alloc , typename... Args>

static Ptr MyNS::Foo::CreateAlloc	(	const Alloc &	alloc,
		Args &&...	args
	)

inlinestatic

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ CreateAlloc() [2/2]

template<typename Alloc , typename... Args>

static Ptr MyNS::Foo::CreateAlloc	(	const Alloc &	alloc,
		Args &&...	args
	)

inlinestatic

Definition at line 22 of file vision_stereo_rectify/test.cpp.

◆ CreateObject() [1/2]

static std::shared_ptr<CObject> MyNS::Foo::CreateObject ( )

static

◆ CreateObject() [2/2]

static std::shared_ptr<CObject> MyNS::Foo::CreateObject ( )

static

◆ CreateUnique() [1/2]

template<typename... Args>

static UniquePtr MyNS::Foo::CreateUnique ( Args &&... args )

inlinestatic

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ CreateUnique() [2/2]

template<typename... Args>

static UniquePtr MyNS::Foo::CreateUnique ( Args &&... args )

inlinestatic

Definition at line 22 of file vision_stereo_rectify/test.cpp.

◆ duplicateGetSmartPtr() [1/2]

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 200 of file CObject.h.

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

Referenced by mrpt::obs::CRawlog::addActions(), and mrpt::obs::CRawlog::addObservations().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duplicateGetSmartPtr() [2/2]

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 200 of file CObject.h.

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

Referenced by mrpt::obs::CRawlog::addActions(), and mrpt::obs::CRawlog::addObservations().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClassName() [1/2]

static constexpr auto MyNS::Foo::getClassName ( )

inlinestatic

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ getClassName() [2/2]

static constexpr auto MyNS::Foo::getClassName ( )

inlinestatic

Definition at line 22 of file vision_stereo_rectify/test.cpp.

◆ GetRuntimeClass() [1/2]

virtual const mrpt::rtti::TRuntimeClassId* MyNS::Foo::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::rtti::CObject.

◆ GetRuntimeClass() [2/2]

virtual const mrpt::rtti::TRuntimeClassId* MyNS::Foo::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::rtti::CObject.

◆ GetRuntimeClassIdStatic() [1/2]

static const mrpt::rtti::TRuntimeClassId& MyNS::Foo::GetRuntimeClassIdStatic ( )

static

◆ GetRuntimeClassIdStatic() [2/2]

static const mrpt::rtti::TRuntimeClassId& MyNS::Foo::GetRuntimeClassIdStatic ( )

static

◆ printName()

void MyNS::Foo::printName ( )

inline

Examples:: rtti_example1/test.cpp.

Definition at line 24 of file vision_stereo_rectify/test.cpp.

◆ serializeFrom() [1/2]

void Foo< INTER_SPACE >::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 31 of file serialization/src/CSerializable_unittest.cpp.

◆ serializeFrom() [2/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:

◆ serializeGetVersion()

uint8_t Foo< INTER_SPACE >::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 29 of file serialization/src/CSerializable_unittest.cpp.

◆ serializeTo() [1/2]

void Foo< INTER_SPACE >::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 30 of file serialization/src/CSerializable_unittest.cpp.

◆ serializeTo() [2/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:

◆ 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

◆ _init_Foo

static mrpt::rtti::CLASSINIT Foo< INTER_SPACE >::_init_Foo

staticprotected

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ className

static constexpr const char * Foo< INTER_SPACE >::className = "Foo"

static

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ runtimeClassId

static const mrpt::rtti::TRuntimeClassId Foo< INTER_SPACE >::runtimeClassId

staticprotected

Definition at line 21 of file serialization/src/CSerializable_unittest.cpp.

◆ value

int16_t MyNS::Foo::value

Definition at line 23 of file serialization/src/CSerializable_unittest.cpp.

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr [1/2]

◆ ConstPtr [2/2]

◆ ConstUniquePtr [1/2]

◆ ConstUniquePtr [2/2]

◆ Ptr [1/2]

◆ Ptr [2/2]

◆ UniquePtr [1/2]

◆ UniquePtr [2/2]

Constructor & Destructor Documentation

◆ Foo()

Member Function Documentation

◆ _GetBaseClass() [1/2]

◆ _GetBaseClass() [2/2]

◆ clone() [1/2]

◆ clone() [2/2]

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateAlloc() [1/2]

◆ CreateAlloc() [2/2]

◆ CreateObject() [1/2]

◆ CreateObject() [2/2]

◆ CreateUnique() [1/2]

◆ CreateUnique() [2/2]

◆ duplicateGetSmartPtr() [1/2]

◆ duplicateGetSmartPtr() [2/2]

◆ getClassName() [1/2]

◆ getClassName() [2/2]

◆ GetRuntimeClass() [1/2]

◆ GetRuntimeClass() [2/2]

◆ GetRuntimeClassIdStatic() [1/2]

◆ GetRuntimeClassIdStatic() [2/2]

◆ printName()

◆ serializeFrom() [1/2]

◆ serializeFrom() [2/2]

◆ serializeGetVersion()

◆ serializeTo() [1/2]

◆ serializeTo() [2/2]

◆ writeToMatlab()

Member Data Documentation

◆ _init_Foo

◆ className

◆ runtimeClassId

◆ value