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 in the wiki.

See also:: CStream

#include <mrpt/utils/CSerializable.h>

Inherits mrpt::utils::CObject.

Inherited by mrpt::detectors::CDetectableObject, mrpt::graphs::CNetworkOfPoses2D, mrpt::graphs::CNetworkOfPoses2DCov, mrpt::graphs::CNetworkOfPoses2DInf, mrpt::graphs::CNetworkOfPoses3D, mrpt::graphs::CNetworkOfPoses3DCov, mrpt::graphs::CNetworkOfPoses3DInf, 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::math::CMatrix, mrpt::math::CMatrixB, mrpt::math::CMatrixD, mrpt::math::CPolygon, mrpt::math::CSplineInterpolator1D, mrpt::opengl::COpenGLScene, mrpt::opengl::COpenGLViewport, mrpt::opengl::CRenderizable, mrpt::poses::CPoint2D, mrpt::poses::CPoint2DPDF, mrpt::poses::CPoint3D, mrpt::poses::CPointPDF, mrpt::poses::CPose2D, mrpt::poses::CPose3D, mrpt::poses::CPose3DInterpolator, mrpt::poses::CPose3DPDF, mrpt::poses::CPose3DQuat, mrpt::poses::CPose3DQuatPDF, mrpt::poses::CPosePDF, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::poses::TSimple3DPoint, mrpt::reactivenav::CHolonomicLogFileRecord, mrpt::reactivenav::CLogFileRecord, mrpt::slam::CAction, mrpt::slam::CActionCollection, mrpt::slam::CIncrementalMapPartitioner, mrpt::slam::CLandmark, mrpt::slam::CMetricMap, mrpt::slam::CMultiMetricMapPDF, mrpt::slam::CObservation, mrpt::slam::CRawlog, mrpt::slam::CRBPFParticleData, mrpt::slam::CSensoryFrame, mrpt::slam::CSimpleMap, 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.

List of all members.

Public Member Functions
virtual	~CSerializable ()
virtual CObject *	duplicate () const =0
	Returns a copy of the object, indepently of its class.
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).
CObject *	clone () const
	Cloning interface for smart pointers.
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.
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.
RTTI stuff
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.

Constructor & Destructor Documentation

virtual mrpt::utils::CSerializable::~CSerializable ( ) [inline, virtual]

Definition at line 58 of file CSerializable.h.

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::utils::CSerializable::_GetBaseClass ( ) [static, protected]

Reimplemented from mrpt::utils::CObject.

CObject* mrpt::utils::CObject::clone ( ) const [inline, inherited]

Cloning interface for smart pointers.

Reimplemented in mrpt::opengl::CRenderizable, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 154 of file CObject.h.

virtual CObject* mrpt::utils::CObject::duplicate ( ) const [pure virtual, inherited]

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

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const [inline, inherited]

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

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.

virtual void mrpt::utils::CSerializable::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)		`[protected, pure 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

Implemented in mrpt::math::CMatrixD, and mrpt::math::CMatrix.

virtual void mrpt::utils::CSerializable::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const `[protected, pure 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