mrpt::slam::CAction Class Reference

---

Detailed Description

Declares a class for storing a robot action.

It is used in mrpt::slam::CRawlog, for logs storage and particle filter based simulations. See derived classes for implementations.

See also:

CActionCollection, CRawlog

#include <mrpt/slam/CAction.h>

Inheritance diagram for mrpt::slam::CAction:

List of all members.

Public Member Functions
	CAction ()
	Default constructor.
virtual	~CAction ()
	Constructor.
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.
Public Attributes
mrpt::system::TTimeStamp	timestamp
	The associated time-stamp.
Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable
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	classCAction
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

mrpt::slam::CAction::CAction

(

)

Default constructor.

virtual mrpt::slam::CAction::~CAction

(

)

[virtual]

Constructor.

---

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::slam::CAction::_GetBaseClass

(

)

[static, protected]

Reimplemented from mrpt::utils::CSerializable.

Reimplemented in mrpt::slam::CActionRobotMovement2D, and mrpt::slam::CActionRobotMovement3D.

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.

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

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::slam::CAction::GetRuntimeClass

(

)

const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

Reimplemented in mrpt::slam::CActionRobotMovement2D, and mrpt::slam::CActionRobotMovement3D.

virtual void mrpt::utils::CSerializable::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)		[protected, pure virtual, inherited]

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, inherited]

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

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

---

Friends And Related Function Documentation

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

Reimplemented from mrpt::utils::CSerializable.

Definition at line 55 of file CAction.h.

---

Member Data Documentation

const mrpt::utils::TRuntimeClassId mrpt::slam::CAction::classCAction [static]

Definition at line 55 of file CAction.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject [static, inherited]

Definition at line 139 of file CObject.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable [static, inherited]

Definition at line 56 of file CSerializable.h.

mrpt::system::TTimeStamp mrpt::slam::CAction::timestamp

The associated time-stamp.

This was added at 2-Dec-2007, new serialization versions have been added to derived classes to manage this time-stamp. Prior versions will be read as having a INVALID_TIMESTAMP value.

Definition at line 69 of file CAction.h.