mrpt::utils::CSerializable Class Reference

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

#include <mrpt/utils/CSerializable.h>

Inherited by 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::CPoint2DPDF, mrpt::poses::CPointPDF, mrpt::poses::CPose3DInterpolator, mrpt::poses::CPose3DPDF, mrpt::poses::CPose3DQuatPDF, mrpt::poses::CPoseOrPoint, 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::CImageFloat, mrpt::utils::CMemoryChunk, mrpt::utils::CMHPropertiesValuesList, mrpt::utils::CPropertiesValuesList, mrpt::utils::CSimpleDatabase, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CStringList, mrpt::utils::CTypeSelector, mrpt::utils::TCamera, and mrpt::vision::CFeature.

Collaboration diagram for mrpt::utils::CSerializable:

[legend]

List of all members.

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.
Private Member Functions
virtual	~CSerializable ()

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

Definition at line 48 of file CSerializable.h.

Constructor & Destructor Documentation

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

Definition at line 53 of file CSerializable.h.

Member Function Documentation

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

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.