CSerializable.h File Reference

#include <mrpt/rtti/CObject.h>
#include <mrpt/serialization/serialization_frwds.h>
#include <cstdint>

Include dependency graph for CSerializable.h:

Go to the source code of this file.

Classes
class	mrpt::serialization::CSerializable
	The virtual base class which provides a unified interface for all persistent objects in MRPT. More...

Namespaces
	mrpt::serialization

Macros
#define	DEFINE_SERIALIZABLE(class_name)
	This declaration must be inserted in all CSerializable classes definition, within the class declaration. More...
#define	IMPLEMENTS_SERIALIZABLE(class_name, base, NameSpace)   IMPLEMENTS_MRPT_OBJECT(class_name, base, NameSpace)
	This must be inserted in all CSerializable classes implementation files. More...
#define	DEFINE_VIRTUAL_SERIALIZABLE(class_name)   DEFINE_VIRTUAL_MRPT_OBJECT(class_name)
	This declaration must be inserted in virtual CSerializable classes definition: More...
#define	IMPLEMENTS_VIRTUAL_SERIALIZABLE( class_name, base_class_name, NameSpace)   IMPLEMENTS_VIRTUAL_MRPT_OBJECT(class_name, base_class_name, NameSpace)
	This must be inserted as implementation of some required members for virtual CSerializable classes: More...
#define	DECLARE_MEX_CONVERSION
	This must be inserted if a custom conversion method for MEX API is implemented in the class. More...
#define	DECLARE_MEXPLUS_FROM(complete_type)
	This must be inserted if a custom conversion method for MEX API is implemented in the class. More...
#define	IMPLEMENTS_MEXPLUS_FROM(complete_type)

Typedefs
using	mxArray = struct mxArray_tag
	Forward declaration for mxArray (avoid #including as much as possible to speed up compiling) More...

Functions
void	mrpt::serialization::ObjectToOctetVector (const CSerializable *o, std::vector< uint8_t > &out_vector)
	Converts (serializes) an MRPT object into an array of bytes. More...
void	mrpt::serialization::OctetVectorToObject (const std::vector< uint8_t > &in_data, CSerializable::Ptr &obj)
	Converts back (de-serializes) a sequence of binary data into a MRPT object, without prior information about the object's class. More...

Macro Definition Documentation

DECLARE_MEX_CONVERSION

#define DECLARE_MEX_CONVERSION

Value:

/*! @name Virtual methods for MRPT-MEX conversion */ \
    /*! @{ */                                            \
   public:                                               \
    mxArray* writeToMatlab() const override;             \
/*! @} */

This must be inserted if a custom conversion method for MEX API is implemented in the class.

Definition at line 129 of file CSerializable.h.

DECLARE_MEXPLUS_FROM

#define DECLARE_MEXPLUS_FROM

(

complete_type

)

Value:

namespace mexplus                          \
    {                                          \
    template <typename T>                      \
    mxArray* from(const T& value);             \
    template <>                                \
    mxArray* from(const complete_type& value); \
    }

This must be inserted if a custom conversion method for MEX API is implemented in the class.

Definition at line 138 of file CSerializable.h.

DEFINE_SERIALIZABLE

#define DEFINE_SERIALIZABLE

(

class_name

)

Value:

DEFINE_MRPT_OBJECT(class_name)                                           \
   protected:                                                                \
    /*! @name CSerializable virtual methods */                               \
    /*! @{ */                                                                \
    uint8_t serializeGetVersion() const override;                            \
    void serializeTo(mrpt::serialization::CArchive& out) const override;     \
    void serializeFrom(                                                      \
        mrpt::serialization::CArchive& in, uint8_t serial_version) override; \
/*! @} */

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

Definition at line 100 of file CSerializable.h.

DEFINE_VIRTUAL_SERIALIZABLE

#define DEFINE_VIRTUAL_SERIALIZABLE

(

class_name

)

DEFINE_VIRTUAL_MRPT_OBJECT(class_name)

This declaration must be inserted in virtual CSerializable classes definition:

Definition at line 117 of file CSerializable.h.

IMPLEMENTS_MEXPLUS_FROM

#define IMPLEMENTS_MEXPLUS_FROM

(

complete_type

)

Value:

namespace mexplus                          \
    {                                          \
    template <>                                \
    mxArray* from(const complete_type& var)    \
    {                                          \
        return var.writeToMatlab();            \
    }                                          \
    }

Definition at line 147 of file CSerializable.h.

IMPLEMENTS_SERIALIZABLE

#define IMPLEMENTS_SERIALIZABLE	(		class_name,
			base,
			NameSpace
	)		IMPLEMENTS_MRPT_OBJECT(class_name, base, NameSpace)

This must be inserted in all CSerializable classes implementation files.

Definition at line 112 of file CSerializable.h.

IMPLEMENTS_VIRTUAL_SERIALIZABLE

#define IMPLEMENTS_VIRTUAL_SERIALIZABLE	(		class_name,
			base_class_name,
			NameSpace
	)		IMPLEMENTS_VIRTUAL_MRPT_OBJECT(class_name, base_class_name, NameSpace)

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

Definition at line 123 of file CSerializable.h.

Typedef Documentation

mxArray

using mxArray = struct mxArray_tag

Forward declaration for mxArray (avoid #including as much as possible to speed up compiling)

Definition at line 18 of file CSerializable.h.