Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Protected Member Functions

mrpt::utils::CSerializable Class Reference


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.

#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::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::CNetworkOfPoses2D, mrpt::poses::CNetworkOfPoses2DCov, mrpt::poses::CNetworkOfPoses2DInf, mrpt::poses::CNetworkOfPoses3D, mrpt::poses::CNetworkOfPoses3DCov, mrpt::poses::CNetworkOfPoses3DInf, 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 ()

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 53 of file CSerializable.h.


Member Function Documentation

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

Reimplemented from mrpt::utils::CObject.

Reimplemented in mrpt::math::CMatrix, mrpt::math::CMatrixB, mrpt::math::CMatrixD, mrpt::math::CPolygon, mrpt::math::CSplineInterpolator1D, mrpt::poses::CNetworkOfPoses2D, mrpt::poses::CNetworkOfPoses3D, mrpt::poses::CNetworkOfPoses2DCov, mrpt::poses::CNetworkOfPoses3DCov, mrpt::poses::CNetworkOfPoses2DInf, mrpt::poses::CNetworkOfPoses3DInf, mrpt::poses::CPoint2D, mrpt::poses::CPoint2DPDF, mrpt::poses::CPoint2DPDFGaussian, mrpt::poses::CPoint3D, mrpt::poses::CPointPDF, mrpt::poses::CPointPDFGaussian, mrpt::poses::TSimple3DPoint, mrpt::poses::CPointPDFParticles, mrpt::poses::CPointPDFSOG, mrpt::poses::CPose2D, mrpt::poses::CPose3D, mrpt::poses::CPose3DInterpolator, mrpt::poses::CPose3DPDF, mrpt::poses::CPose3DPDFGaussian, mrpt::poses::CPose3DPDFGaussianInf, mrpt::poses::CPose3DPDFParticles, mrpt::poses::CPose3DPDFSOG, mrpt::poses::CPose3DQuat, mrpt::poses::CPose3DQuatPDF, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::poses::CPosePDF, mrpt::poses::CPosePDFGaussian, mrpt::poses::CPosePDFGaussianInf, mrpt::poses::CPosePDFGrid, mrpt::poses::CPosePDFParticles, mrpt::poses::CPosePDFSOG, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::utils::CImage, mrpt::utils::CMemoryChunk, mrpt::utils::CMHPropertiesValuesList, mrpt::utils::CPropertiesValuesList, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CSimpleDatabase, mrpt::utils::CStringList, mrpt::utils::CTypeSelector, mrpt::utils::TCamera, mrpt::utils::TStereoCamera, mrpt::detectors::CDetectableObject, mrpt::detectors::CDetectable2D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::CHierarchicalMHMap, mrpt::hmtslam::CHMHMapArc, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CHMTSLAM, mrpt::hmtslam::CLSLAMParticleData, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::hmtslam::CRobotPosesGraph, mrpt::hmtslam::THypothesisIDSet, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CPlanarLaserScan, mrpt::slam::CBeacon, mrpt::slam::CBeaconMap, mrpt::slam::CColouredPointsMap, mrpt::slam::CGasConcentrationGridMap2D, mrpt::slam::CHeightGridMap2D, mrpt::slam::COccupancyGridMap2D, mrpt::slam::CPointsMap, mrpt::slam::CSimplePointsMap, mrpt::slam::CAction, mrpt::slam::CActionCollection, mrpt::slam::CActionRobotMovement2D, mrpt::slam::CActionRobotMovement3D, mrpt::slam::CMetricMap, mrpt::slam::CObservation, mrpt::slam::CObservation2DRangeScan, mrpt::slam::CObservation3DRangeScan, mrpt::slam::CObservationBatteryState, mrpt::slam::CObservationBeaconRanges, mrpt::slam::CObservationBearingRange, mrpt::slam::CObservationComment, mrpt::slam::CObservationGasSensors, mrpt::slam::CObservationGPS, mrpt::slam::CObservationImage, mrpt::slam::CObservationIMU, mrpt::slam::CObservationOdometry, mrpt::slam::CObservationRange, mrpt::slam::CObservationStereoImages, mrpt::slam::CObservationStereoImagesFeatures, mrpt::slam::CRawlog, mrpt::slam::CSensoryFrame, mrpt::slam::CSimpleMap, mrpt::opengl::C3DSScene, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CBox, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CDisk, mrpt::opengl::CEllipsoid, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::opengl::CMesh, mrpt::opengl::COpenGLScene, mrpt::opengl::COpenGLStandardObject, mrpt::opengl::COpenGLViewport, mrpt::opengl::CPointCloud, mrpt::opengl::CPointCloudColoured, mrpt::opengl::CPolyhedron, mrpt::opengl::CRenderizable, mrpt::opengl::CRenderizableDisplayList, mrpt::opengl::CSetOfLines, mrpt::opengl::CSetOfObjects, mrpt::opengl::CSetOfTexturedTriangles, mrpt::opengl::CSetOfTriangles, mrpt::opengl::CSimpleLine, mrpt::opengl::CSphere, mrpt::opengl::CText, mrpt::opengl::CTexturedObject, mrpt::opengl::CTexturedPlane, mrpt::reactivenav::CHolonomicLogFileRecord, mrpt::reactivenav::CLogFileRecord_ND, mrpt::reactivenav::CLogFileRecord_VFF, mrpt::reactivenav::CLogFileRecord, mrpt::slam::CIncrementalMapPartitioner, mrpt::slam::CMultiMetricMap, mrpt::slam::CRBPFParticleData, mrpt::slam::CMultiMetricMapPDF, mrpt::slam::CLandmark, mrpt::slam::CLandmarksMap, mrpt::slam::CObservationVisualLandmarks, and mrpt::vision::CFeature.

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.

Reimplemented in mrpt::math::CMatrix, mrpt::math::CMatrixB, mrpt::math::CMatrixD, mrpt::math::CPolygon, mrpt::math::CSplineInterpolator1D, mrpt::poses::CNetworkOfPoses2D, mrpt::poses::CNetworkOfPoses3D, mrpt::poses::CNetworkOfPoses2DCov, mrpt::poses::CNetworkOfPoses3DCov, mrpt::poses::CNetworkOfPoses2DInf, mrpt::poses::CNetworkOfPoses3DInf, mrpt::poses::CPoint2D, mrpt::poses::CPoint2DPDF, mrpt::poses::CPoint2DPDFGaussian, mrpt::poses::CPoint3D, mrpt::poses::CPointPDF, mrpt::poses::CPointPDFGaussian, mrpt::poses::TSimple3DPoint, mrpt::poses::CPointPDFParticles, mrpt::poses::CPointPDFSOG, mrpt::poses::CPose2D, mrpt::poses::CPose3D, mrpt::poses::CPose3DInterpolator, mrpt::poses::CPose3DPDF, mrpt::poses::CPose3DPDFGaussian, mrpt::poses::CPose3DPDFGaussianInf, mrpt::poses::CPose3DPDFParticles, mrpt::poses::CPose3DPDFSOG, mrpt::poses::CPose3DQuat, mrpt::poses::CPose3DQuatPDF, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::poses::CPosePDF, mrpt::poses::CPosePDFGaussian, mrpt::poses::CPosePDFGaussianInf, mrpt::poses::CPosePDFGrid, mrpt::poses::CPosePDFParticles, mrpt::poses::CPosePDFSOG, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::utils::CImage, mrpt::utils::CMemoryChunk, mrpt::utils::CMHPropertiesValuesList, mrpt::utils::CPropertiesValuesList, mrpt::utils::CSimpleDatabaseTable, mrpt::utils::CSimpleDatabase, mrpt::utils::CStringList, mrpt::utils::CTypeSelector, mrpt::utils::TCamera, mrpt::utils::TStereoCamera, mrpt::detectors::CDetectableObject, mrpt::detectors::CDetectable2D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::CHierarchicalMHMap, mrpt::hmtslam::CHMHMapArc, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CHMTSLAM, mrpt::hmtslam::CLSLAMParticleData, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::hmtslam::CRobotPosesGraph, mrpt::hmtslam::THypothesisIDSet, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CPlanarLaserScan, mrpt::slam::CBeacon, mrpt::slam::CBeaconMap, mrpt::slam::CColouredPointsMap, mrpt::slam::CGasConcentrationGridMap2D, mrpt::slam::CHeightGridMap2D, mrpt::slam::COccupancyGridMap2D, mrpt::slam::CPointsMap, mrpt::slam::CSimplePointsMap, mrpt::slam::CAction, mrpt::slam::CActionCollection, mrpt::slam::CActionRobotMovement2D, mrpt::slam::CActionRobotMovement3D, mrpt::slam::CMetricMap, mrpt::slam::CObservation, mrpt::slam::CObservation2DRangeScan, mrpt::slam::CObservation3DRangeScan, mrpt::slam::CObservationBatteryState, mrpt::slam::CObservationBeaconRanges, mrpt::slam::CObservationBearingRange, mrpt::slam::CObservationComment, mrpt::slam::CObservationGasSensors, mrpt::slam::CObservationGPS, mrpt::slam::CObservationImage, mrpt::slam::CObservationIMU, mrpt::slam::CObservationOdometry, mrpt::slam::CObservationRange, mrpt::slam::CObservationStereoImages, mrpt::slam::CObservationStereoImagesFeatures, mrpt::slam::CRawlog, mrpt::slam::CSensoryFrame, mrpt::slam::CSimpleMap, mrpt::opengl::C3DSScene, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CBox, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CDisk, mrpt::opengl::CEllipsoid, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::opengl::CMesh, mrpt::opengl::COpenGLScene, mrpt::opengl::COpenGLStandardObject, mrpt::opengl::COpenGLViewport, mrpt::opengl::CPointCloud, mrpt::opengl::CPointCloudColoured, mrpt::opengl::CPolyhedron, mrpt::opengl::CRenderizable, mrpt::opengl::CRenderizableDisplayList, mrpt::opengl::CSetOfLines, mrpt::opengl::CSetOfObjects, mrpt::opengl::CSetOfTexturedTriangles, mrpt::opengl::CSetOfTriangles, mrpt::opengl::CSimpleLine, mrpt::opengl::CSphere, mrpt::opengl::CText, mrpt::opengl::CTexturedObject, mrpt::opengl::CTexturedPlane, mrpt::reactivenav::CHolonomicLogFileRecord, mrpt::reactivenav::CLogFileRecord_ND, mrpt::reactivenav::CLogFileRecord_VFF, mrpt::reactivenav::CLogFileRecord, mrpt::slam::CIncrementalMapPartitioner, mrpt::slam::CMultiMetricMap, mrpt::slam::CRBPFParticleData, mrpt::slam::CMultiMetricMapPDF, mrpt::slam::CLandmark, mrpt::slam::CLandmarksMap, mrpt::slam::CObservationVisualLandmarks, and mrpt::vision::CFeature.

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:
inThe input binary stream where the object data must read from.
versionThe 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::exceptionOn any error, see CStream::ReadBuffer
See also:
CStream

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

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:
outThe output binary stream where object must be dumped.
getVersionIf 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::exceptionOn any error, see CStream::WriteBuffer
See also:
CStream

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


Friends And Related Function Documentation

friend class mrpt::utils::CStream [friend]

Member Data Documentation

Definition at line 51 of file CSerializable.h.




Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:16:28 UTC 2011