mrpt::kinematics::CVehicleVelCmd Class Reference

Detailed Description

Virtual base for velocity commands of different kinematic models of planar mobile robot.

Definition at line 20 of file CVehicleVelCmd.h.

#include <mrpt/kinematics/CVehicleVelCmd.h>

Inheritance diagram for mrpt::kinematics::CVehicleVelCmd:

Classes
struct	TVelCmdParams
	Parameters that may be used by cmdVel_limits() in any derived classes. More...

Public Member Functions
	CVehicleVelCmd ()
	CVehicleVelCmd (const CVehicleVelCmd &other)
virtual	~CVehicleVelCmd ()
CVehicleVelCmd &	operator= (const CVehicleVelCmd &other)
virtual size_t	getVelCmdLength () const =0
	Get number of components in each velocity command. More...
virtual std::string	getVelCmdDescription (const int index) const =0
	Get textual, human-readable description of each velocity command component. More...
virtual double	getVelCmdElement (const int index) const =0
	Get each velocity command component. More...
virtual void	setVelCmdElement (const int index, const double val)=0
	Set each velocity command component. More...
virtual bool	isStopCmd () const =0
	Returns true if the command means "do not move" / "stop". More...
virtual void	setToStop ()=0
	Set to a command that means "do not move" / "stop". More...
std::string	asString () const
	Returns a human readable description of the cmd. More...
virtual void	cmdVel_scale (double vel_scale)=0
	Scale the velocity command encoded in this object. More...
virtual double	cmdVel_limits (const mrpt::kinematics::CVehicleVelCmd &prev_vel_cmd, const double beta, const TVelCmdParams &params)=0
	Updates this command, computing a blended version of beta (within [0,1]) of vel_cmd and 1-beta of prev_vel_cmd, simultaneously to honoring any user-side maximum velocities. More...
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 *	clone () const =0
	Returns a deep copy (clone) of the object, indepently of its class. More...
RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr	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...

Protected Member Functions
CSerializable virtual methods
virtual uint8_t	serializeGetVersion () const =0
	Must return the current versioning number of the object. More...
virtual void	serializeTo (CArchive &out) const =0
	Pure virtual method for writing (serializing) to an abstract archive. More...
virtual void	serializeFrom (CArchive &in, uint8_t serial_version)=0
	Pure virtual method for reading (deserializing) from an abstract archive. More...

RTTI stuff
using	Ptr = std::shared_ptr< CVehicleVelCmd >
using	ConstPtr = std::shared_ptr< const CVehicleVelCmd >
static const mrpt::rtti::TRuntimeClassId	runtimeClassId
static const mrpt::rtti::TRuntimeClassId *	_GetBaseClass ()
virtual const mrpt::rtti::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...
static const mrpt::rtti::TRuntimeClassId &	GetRuntimeClassIdStatic ()

Member Typedef Documentation

ConstPtr

using mrpt::kinematics::CVehicleVelCmd::ConstPtr = std::shared_ptr<const CVehicleVelCmd >

Definition at line 22 of file CVehicleVelCmd.h.

Ptr

using mrpt::kinematics::CVehicleVelCmd::Ptr = std::shared_ptr< CVehicleVelCmd >

Definition at line 22 of file CVehicleVelCmd.h.

Constructor & Destructor Documentation

CVehicleVelCmd() [1/2]

CVehicleVelCmd::CVehicleVelCmd

(

)

Definition at line 18 of file CVehicleVelCmd.cpp.

CVehicleVelCmd() [2/2]

CVehicleVelCmd::CVehicleVelCmd

(

const CVehicleVelCmd &

other

)

Definition at line 19 of file CVehicleVelCmd.cpp.

~CVehicleVelCmd()

CVehicleVelCmd::~CVehicleVelCmd ( )

virtual

Definition at line 20 of file CVehicleVelCmd.cpp.

Member Function Documentation

_GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::kinematics::CVehicleVelCmd::_GetBaseClass ( )

staticprotected

asString()

std::string mrpt::kinematics::CVehicleVelCmd::asString

(

)

const

Returns a human readable description of the cmd.

Definition at line 21 of file CVehicleVelCmd.cpp.

References mrpt::format().

clone()

virtual CObject* mrpt::rtti::CObject::clone ( ) const

pure virtualinherited

Returns a deep copy (clone) of the object, indepently of its class.

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_FullEval, mrpt::nav::CLogFileRecord_ND, mrpt::maps::CMultiMetricMap, mrpt::img::CImage, mrpt::db::CSimpleDatabase, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::kinematics::CKinematicChain, mrpt::obs::CObservationGPS, mrpt::maps::CMultiMetricMapPDF, mrpt::opengl::COctoMapVoxels, mrpt::maps::CHeightGridMap2D, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::slam::CIncrementalMapPartitioner, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::obs::CObservation2DRangeScan, mrpt::vision::CFeature, mrpt::nav::CHolonomicFullEval, mrpt::nav::CHolonomicND, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::poses::CPose3DInterpolator, mrpt::opengl::CPointCloudColoured, mrpt::poses::CPose3DQuat, mrpt::opengl::CPointCloud, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::pbmap::PbMap, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::opengl::CPolyhedron, mrpt::pbmap::Plane, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::opengl::CText3D, mrpt::poses::CPose3DRotVec, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::maps::CReflectivityGridMap2D, mrpt::poses::CPose3DPDFGaussianInf, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CAssimpModel, mrpt::opengl::CBox, mrpt::poses::CPose3DPDFGaussian, mrpt::obs::CObservationStereoImages, mrpt::opengl::CMeshFast, mrpt::opengl::CVectorField3D, mrpt::poses::CPose2D, mrpt::poses::CPosePDFParticles, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, MyNS::Bar, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::poses::CPose3DPDFParticles, mrpt::hmtslam::CMHPropertiesValuesList, mrpt::maps::CBeacon, mrpt::maps::COctoMap, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::maps::CRBPFParticleData, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::poses::CPosePDFGaussianInf, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::maps::CColouredOctoMap, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::serialization::CMemoryChunkBase< Derived >, mrpt::maps::CLandmark, mrpt::poses::CPoint3D, mrpt::poses::CPose3DPDFSOG, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::CSimplePointsMap, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::opengl::CSetOfLines, mrpt::maps::CWeightedPointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPointPDFParticles, mrpt::maps::CColouredPointsMap, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::poses::CPosePDFGaussian, mrpt::obs::CObservationRange, mrpt::img::TCamera, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CMultiObjMotionOpt_Scalarization, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CActionCollection, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::opengl::CSetOfObjects, mrpt::obs::CObservationVisualLandmarks, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::poses::CPosePDFGrid, mrpt::math::CSplineInterpolator1D, mrpt::opengl::COpenGLStandardObject, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::img::TStereoCamera, mrpt::math::CMatrixD, mrpt::opengl::CSetOfTriangles, mrpt::poses::CPointPDFGaussian, mrpt::hmtslam::CPropertiesValuesList, mrpt::math::CMatrix, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CMatrixB, mrpt::opengl::CSetOfTexturedTriangles, mrpt::poses::CPoint2DPDFGaussian, mrpt::math::CPolygon, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, MyNS::Foo, mrpt::db::CSimpleDatabaseTable, mrpt::kinematics::CVehicleVelCmd_DiffDriven, mrpt::kinematics::CVehicleVelCmd_Holo, MyNS::Foo, and MyNS::MyDerived1.

Referenced by mrpt::rtti::CObject::duplicateGetSmartPtr(), mrpt::maps::CSimpleMap::insert(), mrpt::obs::CActionCollection::insert(), and mrpt::poses::CPoseRandomSampler::setPosePDF().

cmdVel_limits()

virtual double mrpt::kinematics::CVehicleVelCmd::cmdVel_limits ( const mrpt::kinematics::CVehicleVelCmd &  prev_vel_cmd, const double  beta, const TVelCmdParams &  params  )

pure virtual

Updates this command, computing a blended version of beta (within [0,1]) of vel_cmd and 1-beta of prev_vel_cmd, simultaneously to honoring any user-side maximum velocities.

Returns

The [0,1] ratio that the cmdvel had to be scaled down, or 1.0 if none.

Implemented in mrpt::kinematics::CVehicleVelCmd_Holo, and mrpt::kinematics::CVehicleVelCmd_DiffDriven.

cmdVel_scale()

virtual void mrpt::kinematics::CVehicleVelCmd::cmdVel_scale ( double  vel_scale )

pure virtual

Scale the velocity command encoded in this object.

Parameters

[in]	vel_scale	A scale within [0,1] reflecting how much should be the raw velocity command be lessen (e.g. for safety reasons,...).
[out]	out_vel_cmd	Users can directly inherit from existing implementations instead of manually redefining this method: mrpt::kinematics::CVehicleVelCmd_DiffDriven mrpt::kinematics::CVehicleVelCmd_Holo

Implemented in mrpt::kinematics::CVehicleVelCmd_Holo, and mrpt::kinematics::CVehicleVelCmd_DiffDriven.

duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr 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 168 of file CObject.h.

References mrpt::rtti::CObject::clone().

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

GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::kinematics::CVehicleVelCmd::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::serialization::CSerializable.

Reimplemented in mrpt::kinematics::CVehicleVelCmd_DiffDriven, and mrpt::kinematics::CVehicleVelCmd_Holo.

GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::kinematics::CVehicleVelCmd::GetRuntimeClassIdStatic ( )

static

getVelCmdDescription()

virtual std::string mrpt::kinematics::CVehicleVelCmd::getVelCmdDescription ( const int  index ) const

pure virtual

Get textual, human-readable description of each velocity command component.

Implemented in mrpt::kinematics::CVehicleVelCmd_Holo, and mrpt::kinematics::CVehicleVelCmd_DiffDriven.

getVelCmdElement()

virtual double mrpt::kinematics::CVehicleVelCmd::getVelCmdElement ( const int  index ) const

pure virtual

Get each velocity command component.

Implemented in mrpt::kinematics::CVehicleVelCmd_Holo, and mrpt::kinematics::CVehicleVelCmd_DiffDriven.

Referenced by operator=().

getVelCmdLength()

virtual size_t mrpt::kinematics::CVehicleVelCmd::getVelCmdLength ( ) const

pure virtual

Get number of components in each velocity command.

Implemented in mrpt::kinematics::CVehicleVelCmd_Holo, and mrpt::kinematics::CVehicleVelCmd_DiffDriven.

Referenced by operator=().

isStopCmd()

virtual bool mrpt::kinematics::CVehicleVelCmd::isStopCmd ( ) const

pure virtual

Returns true if the command means "do not move" / "stop".

See also

setToStop

Implemented in mrpt::kinematics::CVehicleVelCmd_Holo, and mrpt::kinematics::CVehicleVelCmd_DiffDriven.

operator=()

CVehicleVelCmd & CVehicleVelCmd::operator=

(

const CVehicleVelCmd &

other

)

Definition at line 34 of file CVehicleVelCmd.cpp.

References ASSERTMSG_, getVelCmdElement(), getVelCmdLength(), and setVelCmdElement().

serializeFrom()

virtual void mrpt::serialization::CSerializable::serializeFrom ( CArchive &  in, uint8_t  serial_version  )

protectedpure virtualinherited

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

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 I/O error

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_FullEval, mrpt::nav::CLogFileRecord_ND, mrpt::maps::CMultiMetricMap, mrpt::img::CImage, mrpt::db::CSimpleDatabase, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::kinematics::CKinematicChain, mrpt::obs::CObservationGPS, mrpt::maps::CMultiMetricMapPDF, mrpt::opengl::COctoMapVoxels, mrpt::maps::CHeightGridMap2D, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::slam::CIncrementalMapPartitioner, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::obs::CObservation2DRangeScan, mrpt::vision::CFeature, mrpt::nav::CHolonomicFullEval, mrpt::nav::CHolonomicND, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::poses::CPose3DInterpolator, mrpt::opengl::CPointCloudColoured, mrpt::poses::CPose3DQuat, mrpt::opengl::CPointCloud, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::pbmap::PbMap, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::opengl::CPolyhedron, mrpt::pbmap::Plane, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::opengl::CText3D, mrpt::poses::CPose3DRotVec, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::maps::CReflectivityGridMap2D, mrpt::poses::CPose3DPDFGaussianInf, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CAssimpModel, mrpt::opengl::CBox, mrpt::poses::CPose3DPDFGaussian, mrpt::obs::CObservationStereoImages, mrpt::opengl::CMeshFast, mrpt::opengl::CVectorField3D, mrpt::poses::CPose2D, mrpt::poses::CPosePDFParticles, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::poses::CPose3DPDFParticles, mrpt::hmtslam::CMHPropertiesValuesList, mrpt::maps::CBeacon, mrpt::maps::COctoMap, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::maps::CRBPFParticleData, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::poses::CPosePDFGaussianInf, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::maps::CColouredOctoMap, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::serialization::CMemoryChunkBase< Derived >, mrpt::maps::CLandmark, mrpt::poses::CPoint3D, mrpt::poses::CPose3DPDFSOG, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::CSimplePointsMap, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::opengl::CSetOfLines, mrpt::maps::CWeightedPointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPointPDFParticles, mrpt::maps::CColouredPointsMap, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::poses::CPosePDFGaussian, mrpt::obs::CObservationRange, mrpt::img::TCamera, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CActionCollection, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::opengl::CSetOfObjects, mrpt::obs::CObservationVisualLandmarks, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::poses::CPosePDFGrid, mrpt::math::CSplineInterpolator1D, mrpt::opengl::COpenGLStandardObject, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::img::TStereoCamera, mrpt::math::CMatrixD, mrpt::opengl::CSetOfTriangles, mrpt::poses::CPointPDFGaussian, mrpt::hmtslam::CPropertiesValuesList, mrpt::math::CMatrix, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CMatrixB, mrpt::opengl::CSetOfTexturedTriangles, mrpt::poses::CPoint2DPDFGaussian, mrpt::math::CPolygon, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, mrpt::db::CSimpleDatabaseTable, mrpt::kinematics::CVehicleVelCmd_DiffDriven, mrpt::kinematics::CVehicleVelCmd_Holo, and MyNS::Foo.

serializeGetVersion()

virtual uint8_t mrpt::serialization::CSerializable::serializeGetVersion ( ) const

protectedpure virtualinherited

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_FullEval, mrpt::nav::CLogFileRecord_ND, mrpt::maps::CMultiMetricMap, mrpt::img::CImage, mrpt::db::CSimpleDatabase, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::kinematics::CKinematicChain, mrpt::obs::CObservationGPS, mrpt::maps::CMultiMetricMapPDF, mrpt::opengl::COctoMapVoxels, mrpt::maps::CHeightGridMap2D, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::slam::CIncrementalMapPartitioner, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::obs::CObservation2DRangeScan, mrpt::vision::CFeature, mrpt::nav::CHolonomicFullEval, mrpt::nav::CHolonomicND, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::poses::CPose3DInterpolator, mrpt::opengl::CPointCloudColoured, mrpt::poses::CPose3DQuat, mrpt::opengl::CPointCloud, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::pbmap::PbMap, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::opengl::CPolyhedron, mrpt::pbmap::Plane, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::opengl::CText3D, mrpt::poses::CPose3DRotVec, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::maps::CReflectivityGridMap2D, mrpt::poses::CPose3DPDFGaussianInf, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CAssimpModel, mrpt::opengl::CBox, mrpt::poses::CPose3DPDFGaussian, mrpt::obs::CObservationStereoImages, mrpt::opengl::CMeshFast, mrpt::opengl::CVectorField3D, mrpt::poses::CPose2D, mrpt::poses::CPosePDFParticles, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::poses::CPose3DPDFParticles, mrpt::hmtslam::CMHPropertiesValuesList, mrpt::maps::CBeacon, mrpt::maps::COctoMap, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::maps::CRBPFParticleData, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::poses::CPosePDFGaussianInf, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::maps::CColouredOctoMap, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::serialization::CMemoryChunkBase< Derived >, mrpt::maps::CLandmark, mrpt::poses::CPoint3D, mrpt::poses::CPose3DPDFSOG, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::CSimplePointsMap, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::opengl::CSetOfLines, mrpt::maps::CWeightedPointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPointPDFParticles, mrpt::maps::CColouredPointsMap, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::poses::CPosePDFGaussian, mrpt::obs::CObservationRange, mrpt::img::TCamera, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CActionCollection, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::opengl::CSetOfObjects, mrpt::obs::CObservationVisualLandmarks, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::poses::CPosePDFGrid, mrpt::math::CSplineInterpolator1D, mrpt::opengl::COpenGLStandardObject, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::img::TStereoCamera, mrpt::math::CMatrixD, mrpt::opengl::CSetOfTriangles, mrpt::poses::CPointPDFGaussian, mrpt::hmtslam::CPropertiesValuesList, mrpt::math::CMatrix, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CMatrixB, mrpt::opengl::CSetOfTexturedTriangles, mrpt::poses::CPoint2DPDFGaussian, mrpt::math::CPolygon, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, mrpt::db::CSimpleDatabaseTable, mrpt::kinematics::CVehicleVelCmd_DiffDriven, mrpt::kinematics::CVehicleVelCmd_Holo, and MyNS::Foo.

Referenced by mrpt::serialization::CArchive::WriteObject().

serializeTo()

virtual void mrpt::serialization::CSerializable::serializeTo ( CArchive &  out ) const

protectedpure virtualinherited

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions

std::exception

On any I/O error

Implemented in mrpt::obs::CObservation3DRangeScan, mrpt::nav::CLogFileRecord_FullEval, mrpt::nav::CLogFileRecord_ND, mrpt::maps::CMultiMetricMap, mrpt::img::CImage, mrpt::db::CSimpleDatabase, mrpt::obs::CObservationIMU, mrpt::maps::TMapGenericParams, mrpt::poses::CPose3D, mrpt::obs::CObservationRGBD360, mrpt::maps::CRandomFieldGridMap3D, mrpt::detectors::CDetectable3D, mrpt::hmtslam::THypothesisIDSet, mrpt::obs::CObservationVelodyneScan, mrpt::maps::CLandmarksMap, mrpt::hmtslam::CHMTSLAM, mrpt::hmtslam::CLocalMetricHypothesis, mrpt::kinematics::CKinematicChain, mrpt::obs::CObservationGPS, mrpt::maps::CMultiMetricMapPDF, mrpt::opengl::COctoMapVoxels, mrpt::maps::CHeightGridMap2D, mrpt::maps::COccupancyGridMap2D, mrpt::obs::CRawlog, mrpt::opengl::COpenGLViewport, mrpt::slam::CIncrementalMapPartitioner, mrpt::opengl::COpenGLScene, mrpt::opengl::CPlanarLaserScan, mrpt::obs::CObservation2DRangeScan, mrpt::vision::CFeature, mrpt::nav::CHolonomicFullEval, mrpt::nav::CHolonomicND, mrpt::obs::CSensoryFrame, mrpt::opengl::CFrustum, mrpt::poses::CPose2DInterpolator, mrpt::nav::CHolonomicVFF, mrpt::opengl::CEllipsoidInverseDepth3D, mrpt::poses::CPose3DInterpolator, mrpt::opengl::CPointCloudColoured, mrpt::poses::CPose3DQuat, mrpt::opengl::CPointCloud, mrpt::opengl::CEllipsoid, mrpt::opengl::CEllipsoidInverseDepth2D, mrpt::pbmap::PbMap, mrpt::detectors::CDetectable2D, mrpt::hmtslam::CLSLAMParticleData, mrpt::maps::CBeaconMap, mrpt::opengl::CPolyhedron, mrpt::pbmap::Plane, mrpt::poses::CPose3DQuatPDFGaussian, mrpt::poses::CPose3DQuatPDFGaussianInf, mrpt::opengl::CText3D, mrpt::poses::CPose3DRotVec, mrpt::opengl::CAngularObservationMesh, mrpt::opengl::CEllipsoidRangeBearing2D, mrpt::maps::CReflectivityGridMap2D, mrpt::poses::CPose3DPDFGaussianInf, mrpt::nav::CPTG_DiffDrive_C, mrpt::opengl::CAssimpModel, mrpt::opengl::CBox, mrpt::poses::CPose3DPDFGaussian, mrpt::obs::CObservationStereoImages, mrpt::opengl::CMeshFast, mrpt::opengl::CVectorField3D, mrpt::poses::CPose2D, mrpt::poses::CPosePDFParticles, mrpt::hmtslam::CHMHMapNode, mrpt::hmtslam::CRobotPosesGraph, mrpt::obs::CObservationStereoImagesFeatures, mrpt::opengl::CMesh, mrpt::poses::CPose3DPDFParticles, mrpt::hmtslam::CMHPropertiesValuesList, mrpt::maps::CBeacon, mrpt::maps::COctoMap, mrpt::opengl::CMesh3D, mrpt::opengl::CText, mrpt::maps::CRBPFParticleData, mrpt::maps::CHeightGridMap2D_MRF, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::poses::CPosePDFGaussianInf, mrpt::poses::CPosePDFSOG, mrpt::hmtslam::CHMHMapArc, mrpt::opengl::CColorBar, mrpt::opengl::CVectorField2D, mrpt::poses::CPoint2D, mrpt::poses::CPointPDFSOG, mrpt::maps::CColouredOctoMap, mrpt::maps::CGasConcentrationGridMap2D, mrpt::maps::CWirelessPowerGridMap2D, mrpt::maps::CSimpleMap, mrpt::obs::CObservationImage, mrpt::serialization::CMemoryChunkBase< Derived >, mrpt::maps::CLandmark, mrpt::poses::CPoint3D, mrpt::poses::CPose3DPDFSOG, mrpt::hmtslam::CHierarchicalMHMap, mrpt::maps::CSimplePointsMap, mrpt::obs::CObservationBatteryState, mrpt::opengl::CDisk, mrpt::opengl::CSetOfLines, mrpt::maps::CWeightedPointsMap, mrpt::nav::CLogFileRecord, mrpt::obs::CActionRobotMovement2D, mrpt::obs::CObservationOdometry, mrpt::obs::CObservationRawDAQ, mrpt::opengl::CCamera, mrpt::opengl::CCylinder, mrpt::opengl::CGridPlaneXY, mrpt::opengl::CGridPlaneXZ, mrpt::poses::CPointPDFParticles, mrpt::maps::CColouredPointsMap, mrpt::obs::CObservationBearingRange, mrpt::obs::CObservationWindSensor, mrpt::opengl::CArrow, mrpt::opengl::CAxis, mrpt::opengl::CGeneralizedCylinder, mrpt::opengl::CSphere, mrpt::poses::CPosePDFGaussian, mrpt::obs::CObservationRange, mrpt::img::TCamera, mrpt::obs::CActionRobotMovement3D, mrpt::obs::CObservationWirelessPower, mrpt::nav::CLogFileRecord_VFF, mrpt::nav::CPTG_Holo_Blend, mrpt::obs::CActionCollection, mrpt::obs::CObservation6DFeatures, mrpt::obs::CObservationSkeleton, mrpt::opengl::CSetOfObjects, mrpt::obs::CObservationVisualLandmarks, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, mrpt::obs::CObservationBeaconRanges, mrpt::obs::CObservationComment, mrpt::obs::CObservationGasSensors, mrpt::obs::CObservationReflectivity, mrpt::obs::CObservationRFID, mrpt::poses::CPosePDFGrid, mrpt::math::CSplineInterpolator1D, mrpt::opengl::COpenGLStandardObject, mrpt::poses::CPoses2DSequence, mrpt::poses::CPoses3DSequence, mrpt::img::TStereoCamera, mrpt::math::CMatrixD, mrpt::opengl::CSetOfTriangles, mrpt::poses::CPointPDFGaussian, mrpt::hmtslam::CPropertiesValuesList, mrpt::math::CMatrix, mrpt::obs::CObservationCANBusJ1939, mrpt::obs::CObservationRobotPose, mrpt::math::CMatrixB, mrpt::opengl::CSetOfTexturedTriangles, mrpt::poses::CPoint2DPDFGaussian, mrpt::math::CPolygon, mrpt::opengl::CSimpleLine, mrpt::opengl::CTexturedPlane, mrpt::db::CSimpleDatabaseTable, mrpt::kinematics::CVehicleVelCmd_DiffDriven, mrpt::kinematics::CVehicleVelCmd_Holo, and MyNS::Foo.

Referenced by mrpt::serialization::CArchive::WriteObject().

setToStop()

virtual void mrpt::kinematics::CVehicleVelCmd::setToStop ( )

pure virtual

Set to a command that means "do not move" / "stop".

See also

isStopCmd

Implemented in mrpt::kinematics::CVehicleVelCmd_Holo, and mrpt::kinematics::CVehicleVelCmd_DiffDriven.

setVelCmdElement()

virtual void mrpt::kinematics::CVehicleVelCmd::setVelCmdElement ( const int  index, const double  val  )

pure virtual

Set each velocity command component.

Implemented in mrpt::kinematics::CVehicleVelCmd_Holo, and mrpt::kinematics::CVehicleVelCmd_DiffDriven.

Referenced by operator=().

writeToMatlab()

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

inlinevirtualinherited

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

Definition at line 68 of file CSerializable.h.

Member Data Documentation

runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::kinematics::CVehicleVelCmd::runtimeClassId

staticprotected

Definition at line 22 of file CVehicleVelCmd.h.