Detailed Description

The virtual base class which provides a unified interface for all persistent objects in MRPT.

Many important properties of this class are inherited from mrpt::utils::CObject. See that class for more details. Refer to the tutorial about serialization online.

See also: CStream

Definition at line 39 of file CSerializable.h.

#include <mrpt/utils/CSerializable.h>

Inherits mrpt::utils::CObject.

Inherited by mrpt::detectors::CDetectableObject, mrpt::hmtslam::CHierarchicalMHMap, mrpt::hmtslam::CHMHMapArc, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CHMTSLAM, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::hmtslam::CLSLAMParticleData, mrpt::hmtslam::CRobotPosesGraph, mrpt::hmtslam::THypothesisIDSet, mrpt::kinematics::CKinematicChain, mrpt::kinematics::CVehicleVelCmd, mrpt::maps::CLandmark, mrpt::maps::CMetricMap, mrpt::maps::CMultiMetricMapPDF, mrpt::maps::CRandomFieldGridMap3D, mrpt::maps::CRBPFParticleData, mrpt::maps::CSimpleMap, mrpt::maps::TMapGenericParams, mrpt::math::CMatrix, mrpt::math::CMatrixB, mrpt::math::CMatrixD, mrpt::math::CPolygon, mrpt::math::CSplineInterpolator1D, mrpt::nav::CAbstractHolonomicReactiveMethod, mrpt::nav::CHolonomicLogFileRecord, mrpt::nav::CLogFileRecord, mrpt::nav::CParameterizedTrajectoryGenerator, mrpt::obs::CAction, mrpt::obs::CActionCollection, mrpt::obs::CObservation, mrpt::obs::CRawlog, mrpt::obs::CSensoryFrame, mrpt::opengl::COpenGLScene, mrpt::opengl::COpenGLViewport, mrpt::opengl::CRenderizable, mrpt::pbmap::PbMap, mrpt::pbmap::Plane, mrpt::poses::CPoint2D, mrpt::poses::CPoint2DPDF, mrpt::poses::CPoint3D, mrpt::poses::CPointPDF, mrpt::poses::CPose2D, mrpt::poses::CPose2DInterpolator, mrpt::poses::CPose3D, mrpt::poses::CPose3DInterpolator, mrpt::poses::CPose3DPDF, mrpt::poses::CPose3DQuat, mrpt::poses::CPose3DQuatPDF, mrpt::poses::CPose3DRotVec, mrpt::poses::CPosePDF, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::poses::TSimple3DPoint, mrpt::slam::CIncrementalMapPartitioner, mrpt::utils::CImage, mrpt::utils::CMemoryChunk, mrpt::utils::CMHPropertiesValuesList, mrpt::utils::CPropertiesValuesList, mrpt::utils::CSimpleDatabase, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CStringList, mrpt::utils::CTypeSelector, mrpt::utils::TCamera, mrpt::utils::TStereoCamera, and mrpt::vision::CFeature.

Public Member Functions
virtual	~CSerializable ()

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

virtual CObject *	duplicate () const =0
	Returns a copy of the object, indepently of its class. More...

CObject *	clone () const
	Cloning interface for smart pointers. More...

RTTI classes and functions
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...

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject

Protected Member Functions
virtual void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const =0
	Introduces a pure virtual method responsible for writing to a CStream. More...

virtual void	readFromStream (mrpt::utils::CStream &in, int version)=0
	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...

RTTI stuff
typedef CSerializablePtr	Ptr

typedef CSerializablePtr	ConstPtr

static const mrpt::utils::TRuntimeClassId	classCSerializable

class	mrpt::utils::CStream

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

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime. More...

Member Typedef Documentation

◆ ConstPtr

typedef CSerializablePtr mrpt::utils::CSerializable::ConstPtr

Definition at line 42 of file CSerializable.h.

◆ Ptr

typedef CSerializablePtr mrpt::utils::CSerializable::Ptr

Definition at line 42 of file CSerializable.h.

Constructor & Destructor Documentation

◆ ~CSerializable()

virtual mrpt::utils::CSerializable::~CSerializable ( )

inlinevirtual

Definition at line 44 of file CSerializable.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::utils::CSerializable::_GetBaseClass ( )

staticprotected

◆ clone()

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 133 of file CObject.h.

◆ duplicate()

virtual CObject* mrpt::utils::CObject::duplicate ( ) const

pure virtualinherited

Returns a copy of the object, indepently of its class.

Referenced by mrpt::poses::CPoseRandomSampler::CPoseRandomSampler(), mrpt::maps::CSimpleMap::insert(), mrpt::obs::CActionCollection::insert(), mrpt::poses::CPoseRandomSampler::operator=(), and mrpt::poses::CPoseRandomSampler::setPosePDF().

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

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

Definition at line 162 of file CObject.h.

References mrpt::utils::CObjectPtr.

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

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::utils::CSerializable::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CObject.

Referenced by mrpt::utils::CStream::internal_ReadObject(), and mrpt::utils::CStream::WriteObject().

◆ readFromStream()

virtual void mrpt::utils::CSerializable::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

protectedpure virtual

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.

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 error, see CStream::ReadBuffer

See also: CStream

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const

inlinevirtual

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 NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

◆ writeToStream()

virtual void mrpt::utils::CSerializable::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

protectedpure virtual

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.

Parameters

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.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Referenced by mrpt::utils::CStream::WriteObject().

Friends And Related Function Documentation

◆ mrpt::utils::CStream

friend class mrpt::utils::CStream

friend

Definition at line 42 of file CSerializable.h.

Member Data Documentation

◆ classCObject

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 118 of file CObject.h.

◆ classCSerializable

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

static

Definition at line 42 of file CSerializable.h.

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ ~CSerializable()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ GetRuntimeClass()

◆ readFromStream()

◆ writeToMatlab()

◆ writeToStream()

Friends And Related Function Documentation

◆ mrpt::utils::CStream

Member Data Documentation

◆ classCObject

◆ classCSerializable